@maxim_mazurok/gapi.client.compute-alpha 0.0.20250729 → 0.0.20250810
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +18 -23
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://www.googleapis.com/discovery/v1/apis/compute/alpha/rest
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250810
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -935,7 +935,7 @@ declare namespace gapi.client {
|
|
|
935
935
|
loadBalancingScheme?: string;
|
|
936
936
|
/** A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration. */
|
|
937
937
|
localityLbPolicies?: BackendServiceLocalityLoadBalancingPolicyConfig[];
|
|
938
|
-
/** 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, see
|
|
938
|
+
/** 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, see Maglev: A Fast and Reliable Software Network Load Balancer. - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the customMetrics field. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. localityLbPolicy cannot be specified with haPolicy. */
|
|
939
939
|
localityLbPolicy?: string;
|
|
940
940
|
/** 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. */
|
|
941
941
|
logConfig?: BackendServiceLogConfig;
|
|
@@ -971,7 +971,7 @@ declare namespace gapi.client {
|
|
|
971
971
|
selfLinkWithId?: string;
|
|
972
972
|
/** URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty. */
|
|
973
973
|
serviceBindings?: string[];
|
|
974
|
-
/** URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is
|
|
974
|
+
/** URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. */
|
|
975
975
|
serviceLbPolicy?: string;
|
|
976
976
|
/** Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). sessionAffinity cannot be specified with haPolicy. */
|
|
977
977
|
sessionAffinity?: string;
|
|
@@ -1256,6 +1256,8 @@ declare namespace gapi.client {
|
|
|
1256
1256
|
interface BackendServiceTlsSettings {
|
|
1257
1257
|
/** Reference to the BackendAuthenticationConfig resource from the networksecurity.googleapis.com namespace. Can be used in authenticating TLS connections to the backend, as specified by the authenticationMode field. Can only be specified if authenticationMode is not NONE. */
|
|
1258
1258
|
authenticationConfig?: string;
|
|
1259
|
+
/** Assigns the Managed Identity for the RegionBackendService Workload. Use this property to configure the load balancer back-end to use certificates and roots of trust provisioned by the Managed Workload Identity system. The `managedIdentity` property is the fully-specified SPIFFE ID to use in the SVID presented by the Load Balancer Workload. The SPIFFE ID must be a resource starting with the "spiffe" scheme identifier, followed by the "trustDomain" property value, followed by the path to the Managed Workload Identity. Supported SPIFFE ID format: - spiffe://<trust_domain>/ns/<namespace>/sa/<subject> The Trust Domain within the Managed Identity must refer to a valid Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig will be inherited from the Workload Identity Pool. Restrictions: - If you set the `managedIdentity` property, you cannot manually set the following fields: - tlsSettings.sni - tlsSettings.subjectAltNames - tlsSettings.authenticationConfig When defining a `managedIdentity` for a RegionBackendServices, the corresponding Workload Identity Pool must have a ca_pool configured in the same region. The system will set up a read-only tlsSettings.authenticationConfig for the Managed Identity. */
|
|
1260
|
+
identity?: string;
|
|
1259
1261
|
/** Server Name Indication - see RFC3546 section 3.1. If set, the load balancer sends this string as the SNI hostname in the TLS connection to the backend, and requires that this string match a Subject Alternative Name (SAN) in the backend's server certificate. With a Regional Internet NEG backend, if the SNI is specified here, the load balancer uses it regardless of whether the Regional Internet NEG is specified with FQDN or IP address and port. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[]. */
|
|
1260
1262
|
sni?: string;
|
|
1261
1263
|
/** A list of Subject Alternative Names (SANs) that the Load Balancer verifies during a TLS handshake with the backend. When the server presents its X.509 certificate to the Load Balancer, the Load Balancer inspects the certificate's SAN field, and requires that at least one SAN match one of the subjectAltNames in the list. This field is limited to 5 entries. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[]. */
|
|
@@ -1734,7 +1736,6 @@ declare namespace gapi.client {
|
|
|
1734
1736
|
selfLinkWithId?: string;
|
|
1735
1737
|
}
|
|
1736
1738
|
interface CompositeHealthCheckAggregatedList {
|
|
1737
|
-
etag?: string;
|
|
1738
1739
|
/** [Output Only] Unique identifier for the resource; defined by the server. */
|
|
1739
1740
|
id?: string;
|
|
1740
1741
|
/** A list of CompositeHealthChecksScopedList resources. */
|
|
@@ -1745,8 +1746,6 @@ declare namespace gapi.client {
|
|
|
1745
1746
|
nextPageToken?: string;
|
|
1746
1747
|
/** [Output Only] Server-defined URL for this resource. */
|
|
1747
1748
|
selfLink?: string;
|
|
1748
|
-
/** [Output Only] Unreachable resources. */
|
|
1749
|
-
unreachables?: string[];
|
|
1750
1749
|
/** [Output Only] Informational warning message. */
|
|
1751
1750
|
warning?: {
|
|
1752
1751
|
/** [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. */
|
|
@@ -1763,7 +1762,6 @@ declare namespace gapi.client {
|
|
|
1763
1762
|
};
|
|
1764
1763
|
}
|
|
1765
1764
|
interface CompositeHealthCheckList {
|
|
1766
|
-
etag?: string;
|
|
1767
1765
|
/** [Output Only] Unique identifier for the resource; defined by the server. */
|
|
1768
1766
|
id?: string;
|
|
1769
1767
|
/** A list of CompositeHealthCheck resources. */
|
|
@@ -1774,8 +1772,6 @@ declare namespace gapi.client {
|
|
|
1774
1772
|
nextPageToken?: string;
|
|
1775
1773
|
/** [Output Only] Server-defined URL for this resource. */
|
|
1776
1774
|
selfLink?: string;
|
|
1777
|
-
/** [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder */
|
|
1778
|
-
unreachables?: string[];
|
|
1779
1775
|
/** [Output Only] Informational warning message. */
|
|
1780
1776
|
warning?: {
|
|
1781
1777
|
/** [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. */
|
|
@@ -3561,7 +3557,6 @@ declare namespace gapi.client {
|
|
|
3561
3557
|
};
|
|
3562
3558
|
}
|
|
3563
3559
|
interface HealthAggregationPolicyList {
|
|
3564
|
-
etag?: string;
|
|
3565
3560
|
/** [Output Only] Unique identifier for the resource; defined by the server. */
|
|
3566
3561
|
id?: string;
|
|
3567
3562
|
/** A list of HealthAggregationPolicy resources. */
|
|
@@ -3572,8 +3567,6 @@ declare namespace gapi.client {
|
|
|
3572
3567
|
nextPageToken?: string;
|
|
3573
3568
|
/** [Output Only] Server-defined URL for this resource. */
|
|
3574
3569
|
selfLink?: string;
|
|
3575
|
-
/** [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder */
|
|
3576
|
-
unreachables?: string[];
|
|
3577
3570
|
/** [Output Only] Informational warning message. */
|
|
3578
3571
|
warning?: {
|
|
3579
3572
|
/** [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. */
|
|
@@ -3840,7 +3833,6 @@ declare namespace gapi.client {
|
|
|
3840
3833
|
sourceType?: string;
|
|
3841
3834
|
}
|
|
3842
3835
|
interface HealthSourceAggregatedList {
|
|
3843
|
-
etag?: string;
|
|
3844
3836
|
/** [Output Only] Unique identifier for the resource; defined by the server. */
|
|
3845
3837
|
id?: string;
|
|
3846
3838
|
/** A list of HealthSourcesScopedList resources. */
|
|
@@ -3851,8 +3843,6 @@ declare namespace gapi.client {
|
|
|
3851
3843
|
nextPageToken?: string;
|
|
3852
3844
|
/** [Output Only] Server-defined URL for this resource. */
|
|
3853
3845
|
selfLink?: string;
|
|
3854
|
-
/** [Output Only] Unreachable resources. */
|
|
3855
|
-
unreachables?: string[];
|
|
3856
3846
|
/** [Output Only] Informational warning message. */
|
|
3857
3847
|
warning?: {
|
|
3858
3848
|
/** [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. */
|
|
@@ -3869,7 +3859,6 @@ declare namespace gapi.client {
|
|
|
3869
3859
|
};
|
|
3870
3860
|
}
|
|
3871
3861
|
interface HealthSourceList {
|
|
3872
|
-
etag?: string;
|
|
3873
3862
|
/** [Output Only] Unique identifier for the resource; defined by the server. */
|
|
3874
3863
|
id?: string;
|
|
3875
3864
|
/** A list of HealthSource resources. */
|
|
@@ -3880,8 +3869,6 @@ declare namespace gapi.client {
|
|
|
3880
3869
|
nextPageToken?: string;
|
|
3881
3870
|
/** [Output Only] Server-defined URL for this resource. */
|
|
3882
3871
|
selfLink?: string;
|
|
3883
|
-
/** [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder */
|
|
3884
|
-
unreachables?: string[];
|
|
3885
3872
|
/** [Output Only] Informational warning message. */
|
|
3886
3873
|
warning?: {
|
|
3887
3874
|
/** [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. */
|
|
@@ -4445,6 +4432,8 @@ declare namespace gapi.client {
|
|
|
4445
4432
|
hostname?: string;
|
|
4446
4433
|
/** [Output Only] The unique identifier for the resource. This identifier is defined by the server. */
|
|
4447
4434
|
id?: string;
|
|
4435
|
+
identity?: string;
|
|
4436
|
+
identityCertificate?: boolean;
|
|
4448
4437
|
/** Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. 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 during the suspend operation. */
|
|
4449
4438
|
instanceEncryptionKey?: CustomerEncryptionKey;
|
|
4450
4439
|
/** KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. */
|
|
@@ -5390,7 +5379,7 @@ declare namespace gapi.client {
|
|
|
5390
5379
|
targetInstance?: string;
|
|
5391
5380
|
}
|
|
5392
5381
|
interface InstanceParams {
|
|
5393
|
-
/** Relative deadline for waiting for capacity. Relevant only for Instances.Insert
|
|
5382
|
+
/** Relative deadline for waiting for capacity. Relevant only for Instances.Insert API. */
|
|
5394
5383
|
requestValidForDuration?: Duration;
|
|
5395
5384
|
/** Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. */
|
|
5396
5385
|
resourceManagerTags?: {[P in string]: string};
|
|
@@ -5410,6 +5399,8 @@ declare namespace gapi.client {
|
|
|
5410
5399
|
displayDevice?: DisplayDevice;
|
|
5411
5400
|
/** A list of guest accelerator cards' type and count to use for instances created from these properties. */
|
|
5412
5401
|
guestAccelerators?: AcceleratorConfig[];
|
|
5402
|
+
identity?: string;
|
|
5403
|
+
identityCertificate?: boolean;
|
|
5413
5404
|
/** KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. */
|
|
5414
5405
|
keyRevocationActionType?: string;
|
|
5415
5406
|
/** Labels to apply to instances that are created from these properties. */
|
|
@@ -5934,6 +5925,8 @@ declare namespace gapi.client {
|
|
|
5934
5925
|
selfLinkWithId?: string;
|
|
5935
5926
|
/** [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. */
|
|
5936
5927
|
state?: string;
|
|
5928
|
+
/** Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned. */
|
|
5929
|
+
subzone?: string;
|
|
5937
5930
|
/** [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty. */
|
|
5938
5931
|
wireGroups?: string[];
|
|
5939
5932
|
}
|
|
@@ -6657,6 +6650,8 @@ declare namespace gapi.client {
|
|
|
6657
6650
|
selfLink?: string;
|
|
6658
6651
|
/** [Output Only] Server-defined URL for this resource with the resource id. */
|
|
6659
6652
|
selfLinkWithId?: string;
|
|
6653
|
+
/** [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other. */
|
|
6654
|
+
singleRegionProductionCriticalPeerLocations?: string[];
|
|
6660
6655
|
/** [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. */
|
|
6661
6656
|
status?: string;
|
|
6662
6657
|
/** [Output Only] Reserved for future use. */
|
|
@@ -12259,7 +12254,7 @@ declare namespace gapi.client {
|
|
|
12259
12254
|
selfLinkWithId?: string;
|
|
12260
12255
|
/** User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */
|
|
12261
12256
|
shortName?: string;
|
|
12262
|
-
/** The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. */
|
|
12257
|
+
/** The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. */
|
|
12263
12258
|
type?: string;
|
|
12264
12259
|
/** Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" */
|
|
12265
12260
|
userDefinedFields?: SecurityPolicyUserDefinedField[];
|
|
@@ -12379,7 +12374,7 @@ declare namespace gapi.client {
|
|
|
12379
12374
|
securityPolicy?: string;
|
|
12380
12375
|
}
|
|
12381
12376
|
interface SecurityPolicyRule {
|
|
12382
|
-
/** The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. */
|
|
12377
|
+
/** The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. - fairshare (preview only): when traffic reaches the threshold limit, requests from the clients matching this rule begin to be rate-limited using the Fair Share algorithm. This action is only allowed in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`. */
|
|
12383
12378
|
action?: string;
|
|
12384
12379
|
/** An optional description of this resource. Provide this property when you create the resource. */
|
|
12385
12380
|
description?: string;
|
|
@@ -12401,7 +12396,7 @@ declare namespace gapi.client {
|
|
|
12401
12396
|
preview?: boolean;
|
|
12402
12397
|
/** 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 priority. */
|
|
12403
12398
|
priority?: number;
|
|
12404
|
-
/** Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. */
|
|
12399
|
+
/** Must be specified if the action is "rate_based_ban" or "throttle" or "fairshare". Cannot be specified for any other actions. */
|
|
12405
12400
|
rateLimitOptions?: SecurityPolicyRuleRateLimitOptions;
|
|
12406
12401
|
/** Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR. */
|
|
12407
12402
|
redirectOptions?: SecurityPolicyRuleRedirectOptions;
|
|
@@ -12525,7 +12520,7 @@ declare namespace gapi.client {
|
|
|
12525
12520
|
banThreshold?: SecurityPolicyRuleRateLimitOptionsThreshold;
|
|
12526
12521
|
/** Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only. */
|
|
12527
12522
|
conformAction?: string;
|
|
12528
|
-
/** Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. */
|
|
12523
|
+
/** Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule. */
|
|
12529
12524
|
enforceOnKey?: string;
|
|
12530
12525
|
/** If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified. */
|
|
12531
12526
|
enforceOnKeyConfigs?: SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig[];
|