class OCI::Apigateway::GatewayClient

API for the API Gateway service. Use this API to manage gateways, deployments, and related items. For more information, see [Overview of API Gateway](/iaas/Content/APIGateway/Concepts/apigatewayoverview.htm).

Attributes

api_client[R]

Client used to make HTTP requests. @return [OCI::ApiClient]

endpoint[R]

Fully qualified endpoint URL @return [String]

region[R]

The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]

retry_config[R]

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries @return [OCI::Retry::RetryConfig]

Public Class Methods

new(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) click to toggle source

Creates a new GatewayClient. Notes:

If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified.  If an endpoint is specified, it will be used instead of the
  region. A region may be specified in the config or via or the region parameter. If specified in both, then the
  region parameter will be used.

@param [Config] config A Config object. @param [String] region A region used to determine the service endpoint. This will usually

correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then

a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication,
so that the instance principals signer can be provided to the client

@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests

the details for the proxy can be provided in this parameter

@param [OCI::Retry::RetryConfig] retry_config The retry configuration for this service client. This represents the default retry configuration to

apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation
will not perform any retries
# File lib/oci/apigateway/gateway_client.rb, line 55
def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20190501'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "GatewayClient endpoint set to '#{@endpoint}'." if logger
end

Public Instance Methods

change_gateway_compartment(gateway_id, change_gateway_compartment_details, opts = {}) click to toggle source

Changes the gateway compartment. @param [String] gateway_id The ocid of the gateway. @param [OCI::Apigateway::Models::ChangeGatewayCompartmentDetails] change_gateway_compartment_details Details of the target compartment. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or

server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.
 (default to null)

@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call

for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource's current etag value.
 (default to null)

@option opts [String] :opc_request_id The client request id for tracing. (default to null) @return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/change_gateway_compartment.rb.html) to see an example of how to use change_gateway_compartment API.

# File lib/oci/apigateway/gateway_client.rb, line 124
def change_gateway_compartment(gateway_id, change_gateway_compartment_details, opts = {})
  logger.debug 'Calling operation GatewayClient#change_gateway_compartment.' if logger

  raise "Missing the required parameter 'gateway_id' when calling change_gateway_compartment." if gateway_id.nil?
  raise "Missing the required parameter 'change_gateway_compartment_details' when calling change_gateway_compartment." if change_gateway_compartment_details.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}/actions/changeCompartment'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_gateway_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#change_gateway_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end
create_gateway(create_gateway_details, opts = {}) click to toggle source

Creates a new gateway.

@param [OCI::Apigateway::Models::CreateGatewayDetails] create_gateway_details Details for the new gateway. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or

server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.
 (default to null)

@option opts [String] :opc_request_id The client request id for tracing. (default to null) @return [Response] A Response object with data of type {OCI::Apigateway::Models::Gateway Gateway} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/create_gateway.rb.html) to see an example of how to use create_gateway API.

# File lib/oci/apigateway/gateway_client.rb, line 188
def create_gateway(create_gateway_details, opts = {})
  logger.debug 'Calling operation GatewayClient#create_gateway.' if logger

  raise "Missing the required parameter 'create_gateway_details' when calling create_gateway." if create_gateway_details.nil?

  path = '/gateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#create_gateway') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Apigateway::Models::Gateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
delete_gateway(gateway_id, opts = {}) click to toggle source

Deletes the gateway with the given identifier. @param [String] gateway_id The ocid of the gateway. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call

for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource's current etag value.
 (default to null)

@option opts [String] :opc_request_id The client request id for tracing. (default to null) @return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/delete_gateway.rb.html) to see an example of how to use delete_gateway API.

# File lib/oci/apigateway/gateway_client.rb, line 249
def delete_gateway(gateway_id, opts = {})
  logger.debug 'Calling operation GatewayClient#delete_gateway.' if logger

  raise "Missing the required parameter 'gateway_id' when calling delete_gateway." if gateway_id.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#delete_gateway') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end
get_gateway(gateway_id, opts = {}) click to toggle source

Gets a gateway by identifier. @param [String] gateway_id The ocid of the gateway. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :opc_request_id The client request id for tracing. (default to null) @return [Response] A Response object with data of type {OCI::Apigateway::Models::Gateway Gateway} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/get_gateway.rb.html) to see an example of how to use get_gateway API.

# File lib/oci/apigateway/gateway_client.rb, line 303
def get_gateway(gateway_id, opts = {})
  logger.debug 'Calling operation GatewayClient#get_gateway.' if logger

  raise "Missing the required parameter 'gateway_id' when calling get_gateway." if gateway_id.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#get_gateway') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Apigateway::Models::Gateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_gateways(compartment_id, opts = {}) click to toggle source

Returns a list of gateways.

@param [String] compartment_id The ocid of the compartment in which to list resources. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :certificate_id Filter gateways by the certificate ocid. (default to null) @option opts [String] :display_name A user-friendly name. Does not have to be unique, and it's changeable.

Example: `My new resource`
 (default to null)

@option opts [String] :lifecycle_state A filter to return only resources that match the given lifecycle state.

Example: `SUCCEEDED`
 (default to null)

@option opts [Integer] :limit The maximum number of items to return. (default to 100) @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. (default to null) @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value. (default to ASC)

Allowed values are: ASC, DESC

@option opts [String] :sort_by The field to sort by. You can provide one sort order (`sortOrder`).

Default order for `timeCreated` is descending. Default order for
`displayName` is ascending. The `displayName` sort order is case
sensitive.
 (default to timeCreated)
Allowed values are: timeCreated, displayName

@option opts [String] :opc_request_id The client request id for tracing. (default to null) @return [Response] A Response object with data of type {OCI::Apigateway::Models::GatewayCollection GatewayCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/list_gateways.rb.html) to see an example of how to use list_gateways API.

# File lib/oci/apigateway/gateway_client.rb, line 377
def list_gateways(compartment_id, opts = {})
  logger.debug 'Calling operation GatewayClient#list_gateways.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_gateways." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Apigateway::Models::Gateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Gateway::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/gateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:certificateId] = opts[:certificate_id] if opts[:certificate_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#list_gateways') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Apigateway::Models::GatewayCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
logger() click to toggle source

@return [Logger] The logger for this client. May be nil.

# File lib/oci/apigateway/gateway_client.rb, line 94
def logger
  @api_client.config.logger
end
region=(new_region) click to toggle source

Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

# File lib/oci/apigateway/gateway_client.rb, line 84
def region=(new_region)
  @region = new_region

  raise 'A region must be specified.' unless @region

  @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://apigateway.{region}.oci.{secondLevelDomain}') + '/20190501'
  logger.info "GatewayClient endpoint set to '#{@endpoint} from region #{@region}'." if logger
end
update_gateway(gateway_id, update_gateway_details, opts = {}) click to toggle source

Updates the gateway with the given identifier. @param [String] gateway_id The ocid of the gateway. @param [OCI::Apigateway::Models::UpdateGatewayDetails] update_gateway_details The information to be updated. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call

for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource's current etag value.
 (default to null)

@option opts [String] :opc_request_id The client request id for tracing. (default to null) @return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/update_gateway.rb.html) to see an example of how to use update_gateway API.

# File lib/oci/apigateway/gateway_client.rb, line 457
def update_gateway(gateway_id, update_gateway_details, opts = {})
  logger.debug 'Calling operation GatewayClient#update_gateway.' if logger

  raise "Missing the required parameter 'gateway_id' when calling update_gateway." if gateway_id.nil?
  raise "Missing the required parameter 'update_gateway_details' when calling update_gateway." if update_gateway_details.nil?
  raise "Parameter value for 'gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(gateway_id)

  path = '/gateways/{gatewayId}'.sub('{gatewayId}', gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GatewayClient#update_gateway') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

Private Instance Methods

applicable_retry_config(opts = {}) click to toggle source

rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines

# File lib/oci/apigateway/gateway_client.rb, line 501
def applicable_retry_config(opts = {})
  return @retry_config unless opts.key?(:retry_config)

  opts[:retry_config]
end