google-cloud-network_services-v1 2.1.0 → 2.3.0

data/proto_docs/google/cloud/networkservices/v1/service_lb_policy.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module NetworkServices
+      module V1
+        # ServiceLbPolicy holds global load balancing and traffic distribution
+        # configuration that can be applied to a BackendService.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. Name of the ServiceLbPolicy resource. It matches pattern
+        #     `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this resource was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this resource was last updated.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Set of label tags associated with the ServiceLbPolicy resource.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. A free-text description of the resource. Max length 1024
+        #     characters.
+        # @!attribute [rw] load_balancing_algorithm
+        #   @return [::Google::Cloud::NetworkServices::V1::ServiceLbPolicy::LoadBalancingAlgorithm]
+        #     Optional. The type of load balancing algorithm to be used. The default
+        #     behavior is WATERFALL_BY_REGION.
+        # @!attribute [rw] auto_capacity_drain
+        #   @return [::Google::Cloud::NetworkServices::V1::ServiceLbPolicy::AutoCapacityDrain]
+        #     Optional. Configuration to automatically move traffic away for unhealthy
+        #     IG/NEG for the associated Backend Service.
+        # @!attribute [rw] failover_config
+        #   @return [::Google::Cloud::NetworkServices::V1::ServiceLbPolicy::FailoverConfig]
+        #     Optional. Configuration related to health based failover.
+        class ServiceLbPolicy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Option to specify if an unhealthy IG/NEG should be considered for global
+          # load balancing and traffic routing.
+          # @!attribute [rw] enable
+          #   @return [::Boolean]
+          #     Optional. If set to 'True', an unhealthy IG/NEG will be set as drained.
+          #     - An IG/NEG is considered unhealthy if less than 25% of the
+          #     instances/endpoints in the IG/NEG are healthy.
+          #     - This option will never result in draining more than 50% of the
+          #     configured IGs/NEGs for the Backend Service.
+          class AutoCapacityDrain
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Option to specify health based failover behavior.
+          # This is not related to Network load balancer FailoverPolicy.
+          # @!attribute [rw] failover_health_threshold
+          #   @return [::Integer]
+          #     Optional. The percentage threshold that a load balancer will begin to
+          #     send traffic to failover backends. If the percentage of endpoints in a
+          #     MIG/NEG is smaller than this value, traffic would be sent to failover
+          #     backends if possible. This field should be set to a value between 1
+          #     and 99. The default value is 50 for Global external HTTP(S) load balancer
+          #     (classic) and Proxyless service mesh, and 70 for others.
+          class FailoverConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The global load balancing algorithm to be used.
+          module LoadBalancingAlgorithm
+            # The type of the loadbalancing algorithm is unspecified.
+            LOAD_BALANCING_ALGORITHM_UNSPECIFIED = 0
+
+            # Balance traffic across all backends across the world proportionally based
+            # on capacity.
+            SPRAY_TO_WORLD = 3
+
+            # Direct traffic to the nearest region with endpoints and capacity before
+            # spilling over to other regions and spread the traffic from each client to
+            # all the MIGs/NEGs in a region.
+            SPRAY_TO_REGION = 4
+
+            # Direct traffic to the nearest region with endpoints and capacity before
+            # spilling over to other regions. All MIGs/NEGs within a region are evenly
+            # loaded but each client might not spread the traffic to all the MIGs/NEGs
+            # in the region.
+            WATERFALL_BY_REGION = 5
+
+            # Attempt to keep traffic in a single zone closest to the client, before
+            # spilling over to other zones.
+            WATERFALL_BY_ZONE = 6
+          end
+        end
+
+        # Request used with the ListServiceLbPolicies method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project and location from which the ServiceLbPolicies should
+        #     be listed, specified in the format
+        #     `projects/{project}/locations/{location}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of ServiceLbPolicies to return per call.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The value returned by the last `ListServiceLbPoliciesResponse`
+        #     Indicates that this is a continuation of a prior `ListRouters` call,
+        #     and that the system should return the next page of data.
+        class ListServiceLbPoliciesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response returned by the ListServiceLbPolicies method.
+        # @!attribute [rw] service_lb_policies
+        #   @return [::Array<::Google::Cloud::NetworkServices::V1::ServiceLbPolicy>]
+        #     List of ServiceLbPolicy resources.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If there might be more results than those appearing in this response, then
+        #     `next_page_token` is included. To get the next set of results, call this
+        #     method again using the value of `next_page_token` as `page_token`.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Unreachable resources. Populated when the request attempts to list all
+        #     resources across all supported locations, while some locations are
+        #     temporarily unavailable.
+        class ListServiceLbPoliciesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request used by the GetServiceLbPolicy method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. A name of the ServiceLbPolicy to get. Must be in the format
+        #     `projects/{project}/locations/{location}/serviceLbPolicies/*`.
+        class GetServiceLbPolicyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request used by the ServiceLbPolicy method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource of the ServiceLbPolicy. Must be in the
+        #     format `projects/{project}/locations/{location}`.
+        # @!attribute [rw] service_lb_policy_id
+        #   @return [::String]
+        #     Required. Short name of the ServiceLbPolicy resource to be created.
+        #     E.g. for resource name
+        #     `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.
+        #     the id is value of \\{service_lb_policy_name}
+        # @!attribute [rw] service_lb_policy
+        #   @return [::Google::Cloud::NetworkServices::V1::ServiceLbPolicy]
+        #     Required. ServiceLbPolicy resource to be created.
+        class CreateServiceLbPolicyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request used by the UpdateServiceLbPolicy method.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Field mask is used to specify the fields to be overwritten in the
+        #     ServiceLbPolicy resource by the update.
+        #     The fields specified in the update_mask are relative to the resource, not
+        #     the full request. A field will be overwritten if it is in the mask. If the
+        #     user does not provide a mask then all fields will be overwritten.
+        # @!attribute [rw] service_lb_policy
+        #   @return [::Google::Cloud::NetworkServices::V1::ServiceLbPolicy]
+        #     Required. Updated ServiceLbPolicy resource.
+        class UpdateServiceLbPolicyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request used by the DeleteServiceLbPolicy method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. A name of the ServiceLbPolicy to delete. Must be in the format
+        #     `projects/{project}/locations/{location}/serviceLbPolicies/*`.
+        class DeleteServiceLbPolicyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/networkservices/v1/tcp_route.rb

@@ -25,7 +25,7 @@ module Google
         # Mesh/Gateway resource.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. Name of the TcpRoute resource. It matches pattern
+        #     Identifier. Name of the TcpRoute resource. It matches pattern
         #     `projects/*/locations/global/tcpRoutes/tcp_route_name>`.
         # @!attribute [r] self_link
         #   @return [::String]
@@ -93,12 +93,10 @@ module Google
           #     Required. Must be specified in the CIDR range format. A CIDR range
           #     consists of an IP Address and a prefix length to construct the subnet
           #     mask. By default, the prefix length is 32 (i.e. matches a single IP
-          #     address). Only IPV4 addresses are supported.
-          #     Examples:
-          #     "10.0.0.1" - matches against this exact IP address.
-          #     "10.0.0.0/8" - matches against any IP address within the 10.0.0.0 subnet
-          #     and 255.255.255.0 mask.
-          #     "0.0.0.0/0" - matches against any IP address'.
+          #     address). Only IPV4 addresses are supported. Examples: "10.0.0.1" -
+          #     matches against this exact IP address. "10.0.0.0/8" - matches against any
+          #     IP address within the 10.0.0.0 subnet and 255.255.255.0 mask. "0.0.0.0/0"
+          #     - matches against any IP address'.
           # @!attribute [rw] port
           #   @return [::String]
           #     Required. Specifies the destination port to match against.
@@ -118,6 +116,13 @@ module Google
           #     Optional. If true, Router will use the destination IP and port of the
           #     original connection as the destination of the request. Default is false.
           #     Only one of route destinations or original destination can be set.
+          # @!attribute [rw] idle_timeout
+          #   @return [::Google::Protobuf::Duration]
+          #     Optional. Specifies the idle timeout for the selected route. The idle
+          #     timeout is defined as the period in which there are no bytes sent or
+          #     received on either the upstream or downstream connection. If not set, the
+          #     default idle timeout is 30 seconds. If set to 0s, the timeout will be
+          #     disabled.
           class RouteAction
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -171,6 +176,11 @@ module Google
         #     The value returned by the last `ListTcpRoutesResponse`
         #     Indicates that this is a continuation of a prior `ListTcpRoutes` call,
         #     and that the system should return the next page of data.
+        # @!attribute [rw] return_partial_success
+        #   @return [::Boolean]
+        #     Optional. If true, allow partial responses for multi-regional Aggregated
+        #     List requests. Otherwise if one of the locations is down or unreachable,
+        #     the Aggregated List request will fail.
         class ListTcpRoutesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -185,6 +195,12 @@ module Google
         #     If there might be more results than those appearing in this response, then
         #     `next_page_token` is included. To get the next set of results, call this
         #     method again using the value of `next_page_token` as `page_token`.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Unreachable resources. Populated when the request opts into
+        #     {::Google::Cloud::NetworkServices::V1::ListTcpRoutesRequest#return_partial_success return_partial_success}
+        #     and reading across collections e.g. when attempting to list all resources
+        #     across all supported locations.
         class ListTcpRoutesResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/networkservices/v1/tls_route.rb

@@ -25,7 +25,7 @@ module Google
         # L3 attributes.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. Name of the TlsRoute resource. It matches pattern
+        #     Identifier. Name of the TlsRoute resource. It matches pattern
         #     `projects/*/locations/global/tlsRoutes/tls_route_name>`.
         # @!attribute [r] self_link
         #   @return [::String]
@@ -61,6 +61,9 @@ module Google
         #
         #     Each gateway reference should match the pattern:
         #     `projects/*/locations/global/gateways/<gateway_name>`
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Set of label tags associated with the TlsRoute resource.
         class TlsRoute
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -70,7 +73,8 @@ module Google
           # @!attribute [rw] matches
           #   @return [::Array<::Google::Cloud::NetworkServices::V1::TlsRoute::RouteMatch>]
           #     Required. RouteMatch defines the predicate used to match requests to a
-          #     given action. Multiple match types are "OR"ed for evaluation.
+          #     given action. Multiple match types are "OR"ed for evaluation. Atleast one
+          #     RouteMatch must be supplied.
           # @!attribute [rw] action
           #   @return [::Google::Cloud::NetworkServices::V1::TlsRoute::RouteAction]
           #     Required. The detailed rule defining how to route matched traffic.
@@ -81,8 +85,6 @@ module Google
 
           # RouteMatch defines the predicate used to match requests to a given action.
           # Multiple match types are "AND"ed for evaluation.
-          # If no routeMatch field is specified, this rule will unconditionally match
-          # traffic.
           # @!attribute [rw] sni_host
           #   @return [::Array<::String>]
           #     Optional. SNI (server name indicator) to match against.
@@ -92,7 +94,7 @@ module Google
           #     Partial wildcards are not supported, and values like *w.example.com are
           #     invalid.
           #     At least one of sni_host and alpn is required.
-          #     Up to 5 sni hosts across all matches can be set.
+          #     Up to 100 sni hosts across all matches can be set.
           # @!attribute [rw] alpn
           #   @return [::Array<::String>]
           #     Optional. ALPN (Application-Layer Protocol Negotiation) to match against.
@@ -109,6 +111,13 @@ module Google
           #   @return [::Array<::Google::Cloud::NetworkServices::V1::TlsRoute::RouteDestination>]
           #     Required. The destination services to which traffic should be forwarded.
           #     At least one destination service is required.
+          # @!attribute [rw] idle_timeout
+          #   @return [::Google::Protobuf::Duration]
+          #     Optional. Specifies the idle timeout for the selected route. The idle
+          #     timeout is defined as the period in which there are no bytes sent or
+          #     received on either the upstream or downstream connection. If not set, the
+          #     default idle timeout is 1 hour. If set to 0s, the timeout will be
+          #     disabled.
           class RouteAction
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -120,7 +129,7 @@ module Google
           #     Required. The URL of a BackendService to route traffic to.
           # @!attribute [rw] weight
           #   @return [::Integer]
-          #     Optional. Specifies the proportion of requests forwareded to the backend
+          #     Optional. Specifies the proportion of requests forwarded to the backend
           #     referenced by the service_name field. This is computed as:
           #     - weight/Sum(weights in destinations)
           #     Weights in all destinations does not need to sum up to 100.
@@ -128,6 +137,15 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Request used with the ListTlsRoutes method.
@@ -143,6 +161,11 @@ module Google
         #     The value returned by the last `ListTlsRoutesResponse`
         #     Indicates that this is a continuation of a prior `ListTlsRoutes` call,
         #     and that the system should return the next page of data.
+        # @!attribute [rw] return_partial_success
+        #   @return [::Boolean]
+        #     Optional. If true, allow partial responses for multi-regional Aggregated
+        #     List requests. Otherwise if one of the locations is down or unreachable,
+        #     the Aggregated List request will fail.
         class ListTlsRoutesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -157,6 +180,12 @@ module Google
         #     If there might be more results than those appearing in this response, then
         #     `next_page_token` is included. To get the next set of results, call this
         #     method again using the value of `next_page_token` as `page_token`.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Unreachable resources. Populated when the request opts into
+        #     {::Google::Cloud::NetworkServices::V1::ListTlsRoutesRequest#return_partial_success return_partial_success}
+        #     and reading across collections e.g. when attempting to list all resources
+        #     across all supported locations.
         class ListTlsRoutesResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-network_services-v1
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Google LLC
@@ -105,13 +105,16 @@ files:
 - lib/google/cloud/networkservices/v1/dep_pb.rb
 - lib/google/cloud/networkservices/v1/dep_services_pb.rb
 - lib/google/cloud/networkservices/v1/endpoint_policy_pb.rb
+- lib/google/cloud/networkservices/v1/extensibility_pb.rb
 - lib/google/cloud/networkservices/v1/gateway_pb.rb
 - lib/google/cloud/networkservices/v1/grpc_route_pb.rb
 - lib/google/cloud/networkservices/v1/http_route_pb.rb
 - lib/google/cloud/networkservices/v1/mesh_pb.rb
 - lib/google/cloud/networkservices/v1/network_services_pb.rb
 - lib/google/cloud/networkservices/v1/network_services_services_pb.rb
+- lib/google/cloud/networkservices/v1/route_view_pb.rb
 - lib/google/cloud/networkservices/v1/service_binding_pb.rb
+- lib/google/cloud/networkservices/v1/service_lb_policy_pb.rb
 - lib/google/cloud/networkservices/v1/tcp_route_pb.rb
 - lib/google/cloud/networkservices/v1/tls_route_pb.rb
 - proto_docs/README.md
@@ -123,11 +126,14 @@ files:
 - proto_docs/google/cloud/networkservices/v1/common.rb
 - proto_docs/google/cloud/networkservices/v1/dep.rb
 - proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb
+- proto_docs/google/cloud/networkservices/v1/extensibility.rb
 - proto_docs/google/cloud/networkservices/v1/gateway.rb
 - proto_docs/google/cloud/networkservices/v1/grpc_route.rb
 - proto_docs/google/cloud/networkservices/v1/http_route.rb
 - proto_docs/google/cloud/networkservices/v1/mesh.rb
+- proto_docs/google/cloud/networkservices/v1/route_view.rb
 - proto_docs/google/cloud/networkservices/v1/service_binding.rb
+- proto_docs/google/cloud/networkservices/v1/service_lb_policy.rb
 - proto_docs/google/cloud/networkservices/v1/tcp_route.rb
 - proto_docs/google/cloud/networkservices/v1/tls_route.rb
 - proto_docs/google/longrunning/operations.rb
@@ -157,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: API Client library for the Network Services V1 API
 test_files: []