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

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.

Attributes

gateway_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the GatewayService Client class.

See {::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::Client::Configuration} for a description of the configuration fields.

@example

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

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# 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
new() { |config| ... } click to toggle source

Create a new GatewayService client object.

@example

# 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

@yield [config] Configure the GatewayService client. @yieldparam config [Client::Configuration]

# 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

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {Client.configure}.

See {::Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# 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) { |response, operation| ... } click to toggle source

DeleteResource performs an HTTP DELETE on the Kubernetes API Server.

@overload delete_resource(request, options = nil)

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

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload delete_resource(content_type: nil, data: nil, extensions: nil)

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

@param content_type [::String]
  The HTTP Content-Type header value specifying the content type of the body.
@param data [::String]
  The HTTP request/response body as raw binary.
@param extensions [::Array<::Google::Protobuf::Any, ::Hash>]
  Application specific response metadata. Must be set in the first response
  for streaming APIs.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Api::HttpBody] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Api::HttpBody]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# 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) { |response, operation| ... } click to toggle source

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

@overload get_resource(request, options = nil)

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

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_resource(content_type: nil, data: nil, extensions: nil)

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

@param content_type [::String]
  The HTTP Content-Type header value specifying the content type of the body.
@param data [::String]
  The HTTP request/response body as raw binary.
@param extensions [::Array<::Google::Protobuf::Any, ::Hash>]
  Application specific response metadata. Must be set in the first response
  for streaming APIs.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Api::HttpBody] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Api::HttpBody]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# 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) { |response, operation| ... } click to toggle source

PatchResource performs an HTTP PATCH on the Kubernetes API Server.

@overload patch_resource(request, options = nil)

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

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload patch_resource(content_type: nil, data: nil, extensions: nil)

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

@param content_type [::String]
  The HTTP Content-Type header value specifying the content type of the body.
@param data [::String]
  The HTTP request/response body as raw binary.
@param extensions [::Array<::Google::Protobuf::Any, ::Hash>]
  Application specific response metadata. Must be set in the first response
  for streaming APIs.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Api::HttpBody] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Api::HttpBody]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# 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) { |response, operation| ... } click to toggle source

PostResource performs an HTTP POST on the Kubernetes API Server.

@overload post_resource(request, options = nil)

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

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload post_resource(content_type: nil, data: nil, extensions: nil)

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

@param content_type [::String]
  The HTTP Content-Type header value specifying the content type of the body.
@param data [::String]
  The HTTP request/response body as raw binary.
@param extensions [::Array<::Google::Protobuf::Any, ::Hash>]
  Application specific response metadata. Must be set in the first response
  for streaming APIs.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Api::HttpBody] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Api::HttpBody]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# 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) { |response, operation| ... } click to toggle source

PutResource performs an HTTP PUT on the Kubernetes API Server.

@overload put_resource(request, options = nil)

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

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload put_resource(content_type: nil, data: nil, extensions: nil)

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

@param content_type [::String]
  The HTTP Content-Type header value specifying the content type of the body.
@param data [::String]
  The HTTP request/response body as raw binary.
@param extensions [::Array<::Google::Protobuf::Any, ::Hash>]
  Application specific response metadata. Must be set in the first response
  for streaming APIs.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Api::HttpBody] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Api::HttpBody]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# 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