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 @@
+
+
+# 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:<value>* will show results only where the value of the property named *isClosed* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* 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 *<value>* then queries like *source:<value>* 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:<value>* will show results only where the value of the property named *closeDate* is later than *<value>*. 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:<value>* will show results only where the value of the property named *closeDate* is earlier than *<value>*. 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:<value>* will show results only where the value of the *closeDate* property matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* 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:<value>* will show results only where the value of the property named *priorityVal* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* 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:<value>* will show results only where the value of the property named *subjectLine* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* 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:<value>* will show results only where the value of the property named *priorityVal* is greater than *<value>*. 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:<value>* will show results only where the value of the property named *priorityVal* is less than *<value>*. 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:<value>* will show results only where the value of the property named *priorityVal* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* 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. Search 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:<value>* will show results only where the value of the property named *subjectLine* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* 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:<value>* will show results only where the value of the property named *closeDate* is later than *<value>*. 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:<value>* will show results only where the value of the property named *closeDate* is earlier than *<value>*. 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:<value>* will show results only where the value of the property named *closeDate* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* 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