Class: Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Rest::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/gke_connect/gateway/v1beta1/gateway_control/rest/client.rb

Overview

REST client for the GatewayControl service.

GatewayControl is the control plane API for Connect Gateway.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new GatewayControl REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the GatewayControl client.

Yield Parameters:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_control/rest/client.rb', line 130

def initialize
  # 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 = ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the GatewayControl Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all GatewayControl clients
::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_control/rest/client.rb', line 63

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

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



100
101
102
103
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_control/rest/client.rb', line 100

def configure
  yield @config if block_given?
  @config
end

#generate_credentials(request, options = nil) ⇒ ::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsResponse #generate_credentials(name: nil, force_use_agent: nil, version: nil, kubernetes_namespace: nil, operating_system: nil) ⇒ ::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsResponse

GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.

Examples:

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::Rest::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

Overloads:

  • #generate_credentials(request, options = nil) ⇒ ::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsResponse

    Pass arguments to generate_credentials via a request object, either of type Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest or an equivalent Hash.

    Parameters:

    • 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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #generate_credentials(name: nil, force_use_agent: nil, version: nil, kubernetes_namespace: nil, operating_system: nil) ⇒ ::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsResponse

    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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The Fleet membership resource.

    • force_use_agent (::Boolean) (defaults to: nil) —

      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.

    • version (::String) (defaults to: nil) —

      Optional. The Connect Gateway version to be used in the resulting configuration.

      Leave this field blank to let the server choose the version (recommended).

    • kubernetes_namespace (::String) (defaults to: nil) —

      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.

    • operating_system (::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest::OperatingSystem) (defaults to: nil) —

      Optional. The operating system where the kubeconfig will be used.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_control/rest/client.rb', line 226

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
  call_metadata = @config.rpcs.generate_credentials.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.generate_credentials.timeout,
                         metadata:     call_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.generate_credentials request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


110
111
112
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_control/rest/client.rb', line 110

def universe_domain
  @gateway_control_stub.universe_domain
end