Class: Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::Client

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

Overview

Client for the GatewayService service.

Gateway service is a public API which works as a Kubernetes resource model proxy between end users and registered Kubernetes clusters. Each RPC in this service matches with an HTTP verb. End user will initiate kubectl commands against the Gateway service, and Gateway service will forward user requests to clusters.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new GatewayService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the GatewayService client.

Yield Parameters:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 112

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/gateway_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 == Client.configure.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_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

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

Configure the GatewayService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 59

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
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the GatewayService 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:



91
92
93
94
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 91

def configure
  yield @config if block_given?
  @config
end

#delete_resource(request, options = nil) ⇒ ::Google::Api::HttpBody #delete_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

DeleteResource performs an HTTP DELETE on the Kubernetes API Server.

Overloads:

  • #delete_resource(request, options = nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to delete_resource via a request object, either of type Api::HttpBody or an equivalent Hash.

    Parameters:

    • request (::Google::Api::HttpBody, ::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.

  • #delete_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to delete_resource 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:

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

      The HTTP Content-Type header value specifying the content type of the body.

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

      The HTTP request/response body as raw binary.

    • extensions (::Array<::Google::Protobuf::Any, ::Hash>) (defaults to: nil) —

      Application specific response metadata. Must be set in the first response for streaming APIs.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 318

def delete_resource request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Api::HttpBody

  # 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.delete_resource.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_resource.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_resource.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gateway_service_stub.call_rpc :delete_resource, 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

#get_resource(request, options = nil) ⇒ ::Google::Api::HttpBody #get_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

GetResource performs an HTTP GET request on the Kubernetes API Server.

Overloads:

  • #get_resource(request, options = nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to get_resource via a request object, either of type Api::HttpBody or an equivalent Hash.

    Parameters:

    • request (::Google::Api::HttpBody, ::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.

  • #get_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to get_resource 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:

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

      The HTTP Content-Type header value specifying the content type of the body.

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

      The HTTP request/response body as raw binary.

    • extensions (::Array<::Google::Protobuf::Any, ::Hash>) (defaults to: nil) —

      Application specific response metadata. Must be set in the first response for streaming APIs.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 184

def get_resource request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Api::HttpBody

  # 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.get_resource.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_resource.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_resource.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gateway_service_stub.call_rpc :get_resource, 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

#patch_resource(request, options = nil) ⇒ ::Google::Api::HttpBody #patch_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

PatchResource performs an HTTP PATCH on the Kubernetes API Server.

Overloads:

  • #patch_resource(request, options = nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to patch_resource via a request object, either of type Api::HttpBody or an equivalent Hash.

    Parameters:

    • request (::Google::Api::HttpBody, ::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.

  • #patch_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to patch_resource 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:

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

      The HTTP Content-Type header value specifying the content type of the body.

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

      The HTTP request/response body as raw binary.

    • extensions (::Array<::Google::Protobuf::Any, ::Hash>) (defaults to: nil) —

      Application specific response metadata. Must be set in the first response for streaming APIs.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 452

def patch_resource request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Api::HttpBody

  # 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.patch_resource.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.patch_resource.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.patch_resource.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gateway_service_stub.call_rpc :patch_resource, 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

#post_resource(request, options = nil) ⇒ ::Google::Api::HttpBody #post_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

PostResource performs an HTTP POST on the Kubernetes API Server.

Overloads:

  • #post_resource(request, options = nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to post_resource via a request object, either of type Api::HttpBody or an equivalent Hash.

    Parameters:

    • request (::Google::Api::HttpBody, ::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.

  • #post_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to post_resource 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:

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

      The HTTP Content-Type header value specifying the content type of the body.

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

      The HTTP request/response body as raw binary.

    • extensions (::Array<::Google::Protobuf::Any, ::Hash>) (defaults to: nil) —

      Application specific response metadata. Must be set in the first response for streaming APIs.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 251

def post_resource request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Api::HttpBody

  # 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.post_resource.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.post_resource.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.post_resource.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gateway_service_stub.call_rpc :post_resource, 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

#put_resource(request, options = nil) ⇒ ::Google::Api::HttpBody #put_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

PutResource performs an HTTP PUT on the Kubernetes API Server.

Overloads:

  • #put_resource(request, options = nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to put_resource via a request object, either of type Api::HttpBody or an equivalent Hash.

    Parameters:

    • request (::Google::Api::HttpBody, ::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.

  • #put_resource(content_type: nil, data: nil, extensions: nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to put_resource 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:

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

      The HTTP Content-Type header value specifying the content type of the body.

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

      The HTTP request/response body as raw binary.

    • extensions (::Array<::Google::Protobuf::Any, ::Hash>) (defaults to: nil) —

      Application specific response metadata. Must be set in the first response for streaming APIs.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 385

def put_resource request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Api::HttpBody

  # 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.put_resource.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.put_resource.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.put_resource.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gateway_service_stub.call_rpc :put_resource, 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