google-cloud-gke_connect-gateway-v1beta1 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11d55858b7ce27b06efa86f9493e238cb7d00f5816f8ff31c6e3af82f6a80b0a
-  data.tar.gz: 7aca890bc9cc9336f28c5c72d57087ca2e642ca0151a734766a927de18d3e581
+  metadata.gz: f01218fa494d18af7b7a63f36d9fbf41055f6d036d217b078ab68112f420581c
+  data.tar.gz: ed395e61b6609b237bcdd920217509a39f95dda894ef129a242164e18661d3a8
 SHA512:
-  metadata.gz: b62613dccccc0a46caeefc626582bc1d935b419ddb3d5328e650c1d2e925b0366b96e5302dc1370bf2e7f8173a45f87253a64fd2d950e292dbb6825f284596f9
-  data.tar.gz: a2ddc71c10b0691ce39f36cfb582d5b28ff81068c4498284920d3e07753e2fb22fde7956ca17c2e16de2e9857468d75809fb2daea703fa5574848b0a547390a0
+  metadata.gz: b8d55438b833bcee1d0461e0b1e25fc8d3c442d80593a0f527355972da70ef9fce543535786b29b0ff8348273d61035eb7836c096587e008d3eb08765f9e50f9
+  data.tar.gz: 4d9db949b0a220b1754ae744ad56dad7ba1708083e7d40a699f454f948bbdfb2b446ad2c095156feea9e6ff1decc01988c2232063844567ac63155f14eabe65d

data/AUTHENTICATION.md

@@ -56,7 +56,7 @@ To configure a credentials file for an individual client initialization:
 ```ruby
 require "google/cloud/gke_connect/gateway/v1beta1"
 
-client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::Client.new do |config|
+client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.new do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 ```
@@ -66,11 +66,11 @@ To configure a credentials file globally for all clients:
 ```ruby
 require "google/cloud/gke_connect/gateway/v1beta1"
 
-::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::Client.configure do |config|
+::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.configure do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 
-client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::Client.new
+client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.new
 ```
 
 ### Environment Variables
@@ -100,7 +100,7 @@ require "google/cloud/gke_connect/gateway/v1beta1"
 
 ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
 
-client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::Client.new
+client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.new
 ```
 
 ### Local ADC file

data/README.md

@@ -32,9 +32,9 @@ In order to use this library, you first need to go through the following steps:
 ```ruby
 require "google/cloud/gke_connect/gateway/v1beta1"
 
-client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::Client.new
-request = ::Google::Api::HttpBody.new # (request fields as keyword arguments...)
-response = client.get_resource request
+client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.new
+request = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest.new # (request fields as keyword arguments...)
+response = client.generate_credentials request
 ```
 
 View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/latest)

data/lib/google/cloud/gke_connect/gateway/v1beta1/gateway_control/client.rb

@@ -0,0 +1,450 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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!
+
+require "google/cloud/errors"
+require "google/cloud/gkeconnect/gateway/v1beta1/control_pb"
+
+module Google
+  module Cloud
+    module GkeConnect
+      module Gateway
+        module V1beta1
+          module GatewayControl
+            ##
+            # Client for the GatewayControl service.
+            #
+            # GatewayControl is the control plane API for Connect Gateway.
+            #
+            class Client
+              # @private
+              API_VERSION = ""
+
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "connectgateway.$UNIVERSE_DOMAIN$"
+
+              # @private
+              attr_reader :gateway_control_stub
+
+              ##
+              # Configure the GatewayControl Client class.
+              #
+              # See {::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @example
+              #
+              #   # Modify the configuration for all GatewayControl clients
+              #   ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.configure do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def self.configure
+                @configure ||= begin
+                  namespace = ["Google", "Cloud", "GkeConnect", "Gateway", "V1beta1"]
+                  parent_config = while namespace.any?
+                                    parent_name = namespace.join "::"
+                                    parent_const = const_get parent_name
+                                    break parent_const.configure if parent_const.respond_to? :configure
+                                    namespace.pop
+                                  end
+                  default_config = Client::Configuration.new parent_config
+
+                  default_config.rpcs.generate_credentials.timeout = 60.0
+                  default_config.rpcs.generate_credentials.retry_policy = {
+                    initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
+                  }
+
+                  default_config
+                end
+                yield @configure if block_given?
+                @configure
+              end
+
+              ##
+              # Configure the GatewayControl Client instance.
+              #
+              # The configuration is set to the derived mode, meaning that values can be changed,
+              # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+              # should be made on {Client.configure}.
+              #
+              # See {::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def configure
+                yield @config if block_given?
+                @config
+              end
+
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @gateway_control_stub.universe_domain
+              end
+
+              ##
+              # Create a new GatewayControl client object.
+              #
+              # @example
+              #
+              #   # Create a client using the default configuration
+              #   client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.new
+              #
+              #   # Create a client using a custom configuration
+              #   client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.new do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the GatewayControl client.
+              # @yieldparam config [Client::Configuration]
+              #
+              def initialize
+                # These require statements are intentionally placed here to initialize
+                # the gRPC module only when it's required.
+                # See https://github.com/googleapis/toolkit/issues/446
+                require "gapic/grpc"
+                require "google/cloud/gkeconnect/gateway/v1beta1/control_services_pb"
+
+                # Create the configuration object
+                @config = Configuration.new Client.configure
+
+                # Yield the configuration if needed
+                yield @config if block_given?
+
+                # Create credentials
+                credentials = @config.credentials
+                # Use self-signed JWT if the endpoint is unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.endpoint.nil? ||
+                                         (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                         !@config.endpoint.split(".").first.include?("-"))
+                credentials ||= Credentials.default scope: @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
+                if credentials.is_a?(::String) || credentials.is_a?(::Hash)
+                  credentials = Credentials.new credentials, scope: @config.scope
+                end
+                @quota_project_id = @config.quota_project
+                @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+                @gateway_control_stub = ::Gapic::ServiceStub.new(
+                  ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Stub,
+                  credentials: credentials,
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  channel_args: @config.channel_args,
+                  interceptors: @config.interceptors,
+                  channel_pool_config: @config.channel_pool
+                )
+              end
+
+              # Service calls
+
+              ##
+              # GenerateCredentials provides connection information that allows a user to
+              # access the specified membership using Connect Gateway.
+              #
+              # @overload generate_credentials(request, options = nil)
+              #   Pass arguments to `generate_credentials` via a request object, either of type
+              #   {::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload generate_credentials(name: nil, force_use_agent: nil, version: nil, kubernetes_namespace: nil, operating_system: nil)
+              #   Pass arguments to `generate_credentials` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param name [::String]
+              #     Required. The Fleet membership resource.
+              #   @param force_use_agent [::Boolean]
+              #     Optional. Whether to force the use of Connect Agent-based transport.
+              #
+              #     This will return a configuration that uses Connect Agent as the underlying
+              #     transport mechanism for cluster types that would otherwise have used a
+              #     different transport. Requires that Connect Agent be installed on the
+              #     cluster. Setting this field to false is equivalent to not setting it.
+              #   @param version [::String]
+              #     Optional. The Connect Gateway version to be used in the resulting
+              #     configuration.
+              #
+              #     Leave this field blank to let the server choose the version (recommended).
+              #   @param kubernetes_namespace [::String]
+              #     Optional. The namespace to use in the kubeconfig context.
+              #
+              #     If this field is specified, the server will set the `namespace` field in
+              #     kubeconfig context. If not specified, the `namespace` field is omitted.
+              #   @param operating_system [::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest::OperatingSystem]
+              #     Optional. The operating system where the kubeconfig will be used.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/gke_connect/gateway/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest.new
+              #
+              #   # Call the generate_credentials method.
+              #   result = client.generate_credentials request
+              #
+              #   # The returned object is of type Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsResponse.
+              #   p result
+              #
+              def generate_credentials request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.generate_credentials.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::GkeConnect::Gateway::V1beta1::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.generate_credentials.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.generate_credentials.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @gateway_control_stub.call_rpc :generate_credentials, request, options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Configuration class for the GatewayControl API.
+              #
+              # This class represents the configuration for GatewayControl,
+              # providing control over timeouts, retry behavior, logging, transport
+              # parameters, and other low-level controls. Certain parameters can also be
+              # applied individually to specific RPCs. See
+              # {::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client::Configuration::Rpcs}
+              # for a list of RPCs that can be configured independently.
+              #
+              # Configuration can be applied globally to all clients, or to a single client
+              # on construction.
+              #
+              # @example
+              #
+              #   # Modify the global config, setting the timeout for
+              #   # generate_credentials to 20 seconds,
+              #   # and all remaining timeouts to 10 seconds.
+              #   ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.configure do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.generate_credentials.timeout = 20.0
+              #   end
+              #
+              #   # Apply the above configuration only to a new client.
+              #   client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client.new do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.generate_credentials.timeout = 20.0
+              #   end
+              #
+              # @!attribute [rw] endpoint
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
+              # @!attribute [rw] credentials
+              #   Credentials to send with calls. You may provide any of the following types:
+              #    *  (`String`) The path to a service account key file in JSON format
+              #    *  (`Hash`) A service account key as a Hash
+              #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
+              #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
+              #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+              #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+              #    *  (`nil`) indicating no credentials
+              #   @return [::Object]
+              # @!attribute [rw] scope
+              #   The OAuth scopes
+              #   @return [::Array<::String>]
+              # @!attribute [rw] lib_name
+              #   The library name as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] lib_version
+              #   The library version as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] channel_args
+              #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+              #   `GRPC::Core::Channel` object is provided as the credential.
+              #   @return [::Hash]
+              # @!attribute [rw] interceptors
+              #   An array of interceptors that are run before calls are executed.
+              #   @return [::Array<::GRPC::ClientInterceptor>]
+              # @!attribute [rw] timeout
+              #   The call timeout in seconds.
+              #   @return [::Numeric]
+              # @!attribute [rw] metadata
+              #   Additional gRPC headers to be sent with the call.
+              #   @return [::Hash{::Symbol=>::String}]
+              # @!attribute [rw] retry_policy
+              #   The retry policy. The value is a hash with the following keys:
+              #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #       trigger a retry.
+              #   @return [::Hash]
+              # @!attribute [rw] quota_project
+              #   A separate project against which to charge quota.
+              #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
+              #
+              class Configuration
+                extend ::Gapic::Config
+
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
+                DEFAULT_ENDPOINT = "connectgateway.googleapis.com"
+
+                config_attr :endpoint,      nil, ::String, nil
+                config_attr :credentials,   nil do |value|
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
+                  allowed.any? { |klass| klass === value }
+                end
+                config_attr :scope,         nil, ::String, ::Array, nil
+                config_attr :lib_name,      nil, ::String, nil
+                config_attr :lib_version,   nil, ::String, nil
+                config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
+                config_attr :interceptors,  nil, ::Array, nil
+                config_attr :timeout,       nil, ::Numeric, nil
+                config_attr :metadata,      nil, ::Hash, nil
+                config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+                config_attr :quota_project, nil, ::String, nil
+                config_attr :universe_domain, nil, ::String, nil
+
+                # @private
+                def initialize parent_config = nil
+                  @parent_config = parent_config unless parent_config.nil?
+
+                  yield self if block_given?
+                end
+
+                ##
+                # Configurations for individual RPCs
+                # @return [Rpcs]
+                #
+                def rpcs
+                  @rpcs ||= begin
+                    parent_rpcs = nil
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+                    Rpcs.new parent_rpcs
+                  end
+                end
+
+                ##
+                # Configuration for the channel pool
+                # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+                #
+                def channel_pool
+                  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+                end
+
+                ##
+                # Configuration RPC class for the GatewayControl API.
+                #
+                # Includes fields providing the configuration for each RPC in this service.
+                # Each configuration object is of type `Gapic::Config::Method` and includes
+                # the following configuration fields:
+                #
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
+                #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
+                #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+                #     include the following keys:
+                #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                #         trigger a retry.
+                #
+                class Rpcs
+                  ##
+                  # RPC-specific configuration for `generate_credentials`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :generate_credentials
+
+                  # @private
+                  def initialize parent_rpcs = nil
+                    generate_credentials_config = parent_rpcs.generate_credentials if parent_rpcs.respond_to? :generate_credentials
+                    @generate_credentials = ::Gapic::Config::Method.new generate_credentials_config
+
+                    yield self if block_given?
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/gke_connect/gateway/v1beta1/{gateway_service → gateway_control}/credentials.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Google LLC
+# Copyright 2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,8 +23,8 @@ module Google
     module GkeConnect
       module Gateway
         module V1beta1
-          module GatewayService
-            # Credentials for the GatewayService API.
+          module GatewayControl
+            # Credentials for the GatewayControl API.
             class Credentials < ::Google::Auth::Credentials
               self.scope = [
                 "https://www.googleapis.com/auth/cloud-platform"