@googleapis/networkservices 32.0.1 → 32.2.0

package/build/v1.d.ts

@@ -101,7 +101,7 @@ export declare namespace networkservices_v1 {
      */
     export interface Schema$AuthzExtension {
         /**
-         * Required. The `:authority` header in the gRPC request sent from Envoy to the extension service.
+         * Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin.
          */
         authority?: string | null;
         /**
@@ -116,6 +116,10 @@ export declare namespace networkservices_v1 {
          * Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.
          */
         failOpen?: boolean | null;
+        /**
+         * Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name.
+         */
+        forwardAttributes?: string[] | null;
         /**
          * Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
          */
@@ -127,7 +131,7 @@ export declare namespace networkservices_v1 {
             [key: string]: string;
         } | null;
         /**
-         * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
+         * Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
          */
         loadBalancingScheme?: string | null;
         /**
@@ -153,7 +157,7 @@ export declare namespace networkservices_v1 {
          */
         updateTime?: string | null;
         /**
-         * Optional. The format of communication supported by the callout extension. If not specified, the default value `EXT_PROC_GRPC` is used.
+         * Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format.
          */
         wireFormat?: string | null;
     }
@@ -320,6 +324,10 @@ export declare namespace networkservices_v1 {
          * Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.
          */
         failOpen?: boolean | null;
+        /**
+         * Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name.
+         */
+        forwardAttributes?: string[] | null;
         /**
          * Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
          */
@@ -335,7 +343,7 @@ export declare namespace networkservices_v1 {
          */
         name?: string | null;
         /**
-         * Optional. When set to `TRUE`, enables `observability_mode` on the `ext_proc` filter. This makes `ext_proc` calls asynchronous. Envoy doesn't check for the response from `ext_proc` calls. For more information about the filter, see: https://www.envoyproxy.io/docs/envoy/v1.32.3/api-v3/extensions/filters/http/ext_proc/v3/ext_proc.proto#extensions-filters-http-ext-proc-v3-externalprocessor This field is helpful when you want to try out the extension in async log-only mode. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. Only `STREAMED` (default) body processing mode is supported.
+         * Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources.
          */
         observabilityMode?: boolean | null;
         /**
@@ -376,6 +384,14 @@ export declare namespace networkservices_v1 {
          * Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.
          */
         addresses?: string[] | null;
+        /**
+         * Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY.
+         */
+        allowGlobalAccess?: boolean | null;
+        /**
+         * Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the `ports` field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'.
+         */
+        allPorts?: boolean | null;
         /**
          * Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
          */
@@ -1465,7 +1481,7 @@ export declare namespace networkservices_v1 {
          */
         operations?: Schema$Operation[];
         /**
-         * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+         * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
          */
         unreachable?: string[] | null;
     }
@@ -2058,6 +2074,10 @@ export declare namespace networkservices_v1 {
          * Output only. Server-defined URL of this resource
          */
         selfLink?: string | null;
+        /**
+         * Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/x/locations/x/targetTcpProxies/`
+         */
+        targetProxies?: string[] | null;
         /**
          * Output only. The timestamp when the resource was updated.
          */
@@ -2376,7 +2396,7 @@ export declare namespace networkservices_v1 {
         get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback<Schema$Location>): void;
         get(callback: BodyResponseCallback<Schema$Location>): void;
         /**
-         * Lists information about the supported locations for this service.
+         * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
          * @example
          * ```js
          * // Before running the sample:
@@ -2406,7 +2426,7 @@ export declare namespace networkservices_v1 {
          *
          *   // Do the magic
          *   const res = await networkservices.projects.locations.list({
-         *     // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
+         *     // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
          *     extraLocationTypes: 'placeholder-value',
          *     // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
          *     filter: 'placeholder-value',
@@ -2453,7 +2473,7 @@ export declare namespace networkservices_v1 {
     }
     export interface Params$Resource$Projects$Locations$List extends StandardParameters {
         /**
-         * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
+         * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
          */
         extraLocationTypes?: string[];
         /**
@@ -2522,6 +2542,7 @@ export declare namespace networkservices_v1 {
          *       //   "createTime": "my_createTime",
          *       //   "description": "my_description",
          *       //   "failOpen": false,
+         *       //   "forwardAttributes": [],
          *       //   "forwardHeaders": [],
          *       //   "labels": {},
          *       //   "loadBalancingScheme": "my_loadBalancingScheme",
@@ -2672,6 +2693,7 @@ export declare namespace networkservices_v1 {
          *   //   "createTime": "my_createTime",
          *   //   "description": "my_description",
          *   //   "failOpen": false,
+         *   //   "forwardAttributes": [],
          *   //   "forwardHeaders": [],
          *   //   "labels": {},
          *   //   "loadBalancingScheme": "my_loadBalancingScheme",
@@ -2818,6 +2840,7 @@ export declare namespace networkservices_v1 {
          *       //   "createTime": "my_createTime",
          *       //   "description": "my_description",
          *       //   "failOpen": false,
+         *       //   "forwardAttributes": [],
          *       //   "forwardHeaders": [],
          *       //   "labels": {},
          *       //   "loadBalancingScheme": "my_loadBalancingScheme",
@@ -4153,6 +4176,8 @@ export declare namespace networkservices_v1 {
          *       // request body parameters
          *       // {
          *       //   "addresses": [],
+         *       //   "allPorts": false,
+         *       //   "allowGlobalAccess": false,
          *       //   "certificateUrls": [],
          *       //   "createTime": "my_createTime",
          *       //   "description": "my_description",
@@ -4306,6 +4331,8 @@ export declare namespace networkservices_v1 {
          *   // Example response
          *   // {
          *   //   "addresses": [],
+         *   //   "allPorts": false,
+         *   //   "allowGlobalAccess": false,
          *   //   "certificateUrls": [],
          *   //   "createTime": "my_createTime",
          *   //   "description": "my_description",
@@ -4451,6 +4478,8 @@ export declare namespace networkservices_v1 {
          *       // request body parameters
          *       // {
          *       //   "addresses": [],
+         *       //   "allPorts": false,
+         *       //   "allowGlobalAccess": false,
          *       //   "certificateUrls": [],
          *       //   "createTime": "my_createTime",
          *       //   "description": "my_description",
@@ -5179,6 +5208,8 @@ export declare namespace networkservices_v1 {
          *     httpRouteId: 'placeholder-value',
          *     // Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/x`.
          *     parent: 'projects/my-project/locations/my-location',
+         *     // Optional. Idempotent request UUID.
+         *     requestId: 'placeholder-value',
          *
          *     // Request body metadata
          *     requestBody: {
@@ -5391,6 +5422,8 @@ export declare namespace networkservices_v1 {
          *
          *   // Do the magic
          *   const res = await networkservices.projects.locations.httpRoutes.list({
+         *     // Optional. Filter expression to restrict the list.
+         *     filter: 'placeholder-value',
          *     // Maximum number of HttpRoutes to return per call.
          *     pageSize: 'placeholder-value',
          *     // The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data.
@@ -5521,6 +5554,10 @@ export declare namespace networkservices_v1 {
          * Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/x`.
          */
         parent?: string;
+        /**
+         * Optional. Idempotent request UUID.
+         */
+        requestId?: string;
         /**
          * Request body metadata
          */
@@ -5539,6 +5576,10 @@ export declare namespace networkservices_v1 {
         name?: string;
     }
     export interface Params$Resource$Projects$Locations$Httproutes$List extends StandardParameters {
+        /**
+         * Optional. Filter expression to restrict the list.
+         */
+        filter?: string;
         /**
          * Maximum number of HttpRoutes to return per call.
          */
@@ -7732,7 +7773,7 @@ export declare namespace networkservices_v1 {
          *     pageSize: 'placeholder-value',
          *     // The standard list page token.
          *     pageToken: 'placeholder-value',
-         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          *     returnPartialSuccess: 'placeholder-value',
          *   });
          *   console.log(res.data);
@@ -7804,7 +7845,7 @@ export declare namespace networkservices_v1 {
          */
         pageToken?: string;
         /**
-         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          */
         returnPartialSuccess?: boolean;
     }
@@ -9123,6 +9164,7 @@ export declare namespace networkservices_v1 {
          *       //   "name": "my_name",
          *       //   "rules": [],
          *       //   "selfLink": "my_selfLink",
+         *       //   "targetProxies": [],
          *       //   "updateTime": "my_updateTime"
          *       // }
          *     },
@@ -9267,6 +9309,7 @@ export declare namespace networkservices_v1 {
          *   //   "name": "my_name",
          *   //   "rules": [],
          *   //   "selfLink": "my_selfLink",
+         *   //   "targetProxies": [],
          *   //   "updateTime": "my_updateTime"
          *   // }
          * }
@@ -9405,6 +9448,7 @@ export declare namespace networkservices_v1 {
          *       //   "name": "my_name",
          *       //   "rules": [],
          *       //   "selfLink": "my_selfLink",
+         *       //   "targetProxies": [],
          *       //   "updateTime": "my_updateTime"
          *       // }
          *     },