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:



124
125
126
127
128
129
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
160
161
162
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 124

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.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_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::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

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:



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

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:



94
95
96
97
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 94

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.

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::GatewayService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Api::HttpBody.new

# Call the delete_resource method.
result = client.delete_resource request

# The returned object is of type Google::Api::HttpBody.
p result

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.



379
380
381
382
383
384
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
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 379

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.

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::GatewayService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Api::HttpBody.new

# Call the get_resource method.
result = client.get_resource request

# The returned object is of type Google::Api::HttpBody.
p result

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.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 215

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.

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::GatewayService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Api::HttpBody.new

# Call the patch_resource method.
result = client.patch_resource request

# The returned object is of type Google::Api::HttpBody.
p result

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.



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 543

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.

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::GatewayService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Api::HttpBody.new

# Call the post_resource method.
result = client.post_resource request

# The returned object is of type Google::Api::HttpBody.
p result

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.



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 297

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.

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::GatewayService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Api::HttpBody.new

# Call the put_resource method.
result = client.put_resource request

# The returned object is of type Google::Api::HttpBody.
p result

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.



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 461

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


104
105
106
 
# File 'lib/google/cloud/gke_connect/gateway/v1beta1/gateway_service/client.rb', line 104

def universe_domain
  @gateway_service_stub.universe_domain
end