class OCI::Apigateway::ApiGatewayClient
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
Client used to make HTTP requests. @return [OCI::ApiClient]
Fully qualified endpoint URL @return [String]
The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]
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
Creates a new ApiGatewayClient
. 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/api_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 "ApiGatewayClient endpoint set to '#{@endpoint}'." if logger end
Public Instance Methods
Changes the API compartment. @param [String] api_id The ocid of the API. @param [OCI::Apigateway::Models::ChangeApiCompartmentDetails] change_api_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_api_compartment.rb.html) to see an example of how to use change_api_compartment
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 124 def change_api_compartment(api_id, change_api_compartment_details, opts = {}) logger.debug 'Calling operation ApiGatewayClient#change_api_compartment.' if logger raise "Missing the required parameter 'api_id' when calling change_api_compartment." if api_id.nil? raise "Missing the required parameter 'change_api_compartment_details' when calling change_api_compartment." if change_api_compartment_details.nil? raise "Parameter value for 'api_id' must not be blank" if OCI::Internal::Util.blank_string?(api_id) path = '/apis/{apiId}/actions/changeCompartment'.sub('{apiId}', api_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_api_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#change_api_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
Changes the certificate compartment. @param [String] certificate_id The ocid of the certificate. @param [OCI::Apigateway::Models::ChangeCertificateCompartmentDetails] change_certificate_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_certificate_compartment.rb.html) to see an example of how to use change_certificate_compartment
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 194 def change_certificate_compartment(certificate_id, change_certificate_compartment_details, opts = {}) logger.debug 'Calling operation ApiGatewayClient#change_certificate_compartment.' if logger raise "Missing the required parameter 'certificate_id' when calling change_certificate_compartment." if certificate_id.nil? raise "Missing the required parameter 'change_certificate_compartment_details' when calling change_certificate_compartment." if change_certificate_compartment_details.nil? raise "Parameter value for 'certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(certificate_id) path = '/certificates/{certificateId}/actions/changeCompartment'.sub('{certificateId}', certificate_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_certificate_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#change_certificate_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
Creates a new API.
@param [OCI::Apigateway::Models::CreateApiDetails] create_api_details Details for the new API. @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::Api Api} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/create_api.rb.html) to see an example of how to use create_api
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 258 def create_api(create_api_details, opts = {}) logger.debug 'Calling operation ApiGatewayClient#create_api.' if logger raise "Missing the required parameter 'create_api_details' when calling create_api." if create_api_details.nil? path = '/apis' 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_api_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#create_api') 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::Api' ) end # rubocop:enable Metrics/BlockLength end
Creates a new Certificate.
@param [OCI::Apigateway::Models::CreateCertificateDetails] create_certificate_details Details for the new certificate @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::Certificate Certificate} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/create_certificate.rb.html) to see an example of how to use create_certificate
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 320 def create_certificate(create_certificate_details, opts = {}) logger.debug 'Calling operation ApiGatewayClient#create_certificate.' if logger raise "Missing the required parameter 'create_certificate_details' when calling create_certificate." if create_certificate_details.nil? path = '/certificates' 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_certificate_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#create_certificate') 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::Certificate' ) end # rubocop:enable Metrics/BlockLength end
Creates a new SDK. @param [OCI::Apigateway::Models::CreateSdkDetails] create_sdk_details Details for the new SDK. @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::Sdk Sdk} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/create_sdk.rb.html) to see an example of how to use create_sdk
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 381 def create_sdk(create_sdk_details, opts = {}) logger.debug 'Calling operation ApiGatewayClient#create_sdk.' if logger raise "Missing the required parameter 'create_sdk_details' when calling create_sdk." if create_sdk_details.nil? path = '/sdks' 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_sdk_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#create_sdk') 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::Sdk' ) end # rubocop:enable Metrics/BlockLength end
Deletes the API with the given identifier. @param [String] api_id The ocid of the API. @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_api.rb.html) to see an example of how to use delete_api
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 442 def delete_api(api_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#delete_api.' if logger raise "Missing the required parameter 'api_id' when calling delete_api." if api_id.nil? raise "Parameter value for 'api_id' must not be blank" if OCI::Internal::Util.blank_string?(api_id) path = '/apis/{apiId}'.sub('{apiId}', api_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: 'ApiGatewayClient#delete_api') 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
Deletes the certificate with the given identifier. @param [String] certificate_id The ocid of the certificate. @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_certificate.rb.html) to see an example of how to use delete_certificate
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 502 def delete_certificate(certificate_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#delete_certificate.' if logger raise "Missing the required parameter 'certificate_id' when calling delete_certificate." if certificate_id.nil? raise "Parameter value for 'certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(certificate_id) path = '/certificates/{certificateId}'.sub('{certificateId}', certificate_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: 'ApiGatewayClient#delete_certificate') 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
Deletes provided SDK. @param [String] sdk_id The ocid of the SDK. @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) @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)
@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_sdk.rb.html) to see an example of how to use delete_sdk
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 562 def delete_sdk(sdk_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#delete_sdk.' if logger raise "Missing the required parameter 'sdk_id' when calling delete_sdk." if sdk_id.nil? raise "Parameter value for 'sdk_id' must not be blank" if OCI::Internal::Util.blank_string?(sdk_id) path = '/sdks/{sdkId}'.sub('{sdkId}', sdk_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] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#delete_sdk') 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
Gets an API by identifier. @param [String] api_id The ocid of the API. @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::Api Api} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/get_api.rb.html) to see an example of how to use get_api
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 616 def get_api(api_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#get_api.' if logger raise "Missing the required parameter 'api_id' when calling get_api." if api_id.nil? raise "Parameter value for 'api_id' must not be blank" if OCI::Internal::Util.blank_string?(api_id) path = '/apis/{apiId}'.sub('{apiId}', api_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: 'ApiGatewayClient#get_api') 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::Api' ) end # rubocop:enable Metrics/BlockLength end
Get the raw API content. @param [String] api_id The ocid of the API. @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) @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, IO] :response_target Streaming
http body into a file (specified by file name or File object) or IO object if the block is not given @option [Block] &block Streaming
http body to the block @return [Response] A Response
object with data of type String if response_target and block are not given, otherwise with nil data @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/get_api_content.rb.html) to see an example of how to use get_api_content
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 678 def get_api_content(api_id, opts = {}, &block) logger.debug 'Calling operation ApiGatewayClient#get_api_content.' if logger raise "Missing the required parameter 'api_id' when calling get_api_content." if api_id.nil? raise "Parameter value for 'api_id' must not be blank" if OCI::Internal::Util.blank_string?(api_id) path = '/apis/{apiId}/content'.sub('{apiId}', api_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/json' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#get_api_content') do if !block.nil? @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: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @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: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @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: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @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: 'String' ) end end # rubocop:enable Metrics/BlockLength end
Gets an API Deployment specification by identifier. @param [String] api_id The ocid of the API. @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) @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)
@return [Response] A Response
object with data of type {OCI::Apigateway::Models::ApiSpecification ApiSpecification} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/get_api_deployment_specification.rb.html) to see an example of how to use get_api_deployment_specification
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 783 def get_api_deployment_specification(api_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#get_api_deployment_specification.' if logger raise "Missing the required parameter 'api_id' when calling get_api_deployment_specification." if api_id.nil? raise "Parameter value for 'api_id' must not be blank" if OCI::Internal::Util.blank_string?(api_id) path = '/apis/{apiId}/deploymentSpecification'.sub('{apiId}', api_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] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#get_api_deployment_specification') 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::ApiSpecification' ) end # rubocop:enable Metrics/BlockLength end
Gets the API validation results. @param [String] api_id The ocid of the API. @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) @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)
@return [Response] A Response
object with data of type {OCI::Apigateway::Models::ApiValidations ApiValidations} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/get_api_validations.rb.html) to see an example of how to use get_api_validations
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 844 def get_api_validations(api_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#get_api_validations.' if logger raise "Missing the required parameter 'api_id' when calling get_api_validations." if api_id.nil? raise "Parameter value for 'api_id' must not be blank" if OCI::Internal::Util.blank_string?(api_id) path = '/apis/{apiId}/validations'.sub('{apiId}', api_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] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#get_api_validations') 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::ApiValidations' ) end # rubocop:enable Metrics/BlockLength end
Gets a certificate by identifier. @param [String] certificate_id The ocid of the certificate. @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::Certificate Certificate} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/get_certificate.rb.html) to see an example of how to use get_certificate
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 899 def get_certificate(certificate_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#get_certificate.' if logger raise "Missing the required parameter 'certificate_id' when calling get_certificate." if certificate_id.nil? raise "Parameter value for 'certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(certificate_id) path = '/certificates/{certificateId}'.sub('{certificateId}', certificate_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: 'ApiGatewayClient#get_certificate') 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::Certificate' ) end # rubocop:enable Metrics/BlockLength end
Return object store downloadable URL and metadata. @param [String] sdk_id The ocid of the SDK. @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::Sdk Sdk} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/get_sdk.rb.html) to see an example of how to use get_sdk
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 953 def get_sdk(sdk_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#get_sdk.' if logger raise "Missing the required parameter 'sdk_id' when calling get_sdk." if sdk_id.nil? raise "Parameter value for 'sdk_id' must not be blank" if OCI::Internal::Util.blank_string?(sdk_id) path = '/sdks/{sdkId}'.sub('{sdkId}', sdk_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: 'ApiGatewayClient#get_sdk') 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::Sdk' ) end # rubocop:enable Metrics/BlockLength end
Returns a list of APIs.
@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] :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: `ACTIVE` (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::ApiCollection ApiCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/list_apis.rb.html) to see an example of how to use list_apis
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 1026 def list_apis(compartment_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#list_apis.' if logger raise "Missing the required parameter 'compartment_id' when calling list_apis." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Apigateway::Models::ApiSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::ApiSummary::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 = '/apis' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_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: 'ApiGatewayClient#list_apis') 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::ApiCollection' ) end # rubocop:enable Metrics/BlockLength end
Returns a list of certificates.
@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] :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: `ACTIVE` or `DELETED` (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::CertificateCollection CertificateCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/list_certificates.rb.html) to see an example of how to use list_certificates
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 1117 def list_certificates(compartment_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#list_certificates.' if logger raise "Missing the required parameter 'compartment_id' when calling list_certificates." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Apigateway::Models::Certificate::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Certificate::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 = '/certificates' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_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: 'ApiGatewayClient#list_certificates') 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::CertificateCollection' ) end # rubocop:enable Metrics/BlockLength end
Lists programming languages in which SDK can be generated. @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] :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 [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::SdkLanguageTypeCollection SdkLanguageTypeCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/list_sdk_language_types.rb.html) to see an example of how to use list_sdk_language_types
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 1203 def list_sdk_language_types(compartment_id, opts = {}) logger.debug 'Calling operation ApiGatewayClient#list_sdk_language_types.' if logger raise "Missing the required parameter 'compartment_id' when calling list_sdk_language_types." if compartment_id.nil? 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 = '/sdkLanguageTypes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] 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: 'ApiGatewayClient#list_sdk_language_types') 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::SdkLanguageTypeCollection' ) end # rubocop:enable Metrics/BlockLength end
Returns list of generated SDKs. @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] :sdk_id The ocid of the SDK. (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: `ACTIVE` or `DELETED` (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] :api_id The ocid of the API. (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::SdkCollection SdkCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/list_sdks.rb.html) to see an example of how to use list_sdks
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 1289 def list_sdks(opts = {}) logger.debug 'Calling operation ApiGatewayClient#list_sdks.' if logger if opts[:lifecycle_state] && !OCI::Apigateway::Models::Sdk::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Sdk::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 = '/sdks' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:sdkId] = opts[:sdk_id] if opts[:sdk_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] query_params[:apiId] = opts[:api_id] if opts[:api_id] # 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: 'ApiGatewayClient#list_sdks') 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::SdkCollection' ) end # rubocop:enable Metrics/BlockLength end
@return [Logger] The logger for this client. May be nil.
# File lib/oci/apigateway/api_gateway_client.rb, line 94 def logger @api_client.config.logger end
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/api_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 "ApiGatewayClient endpoint set to '#{@endpoint} from region #{@region}'." if logger end
Updates the API with the given identifier. @param [String] api_id The ocid of the API. @param [OCI::Apigateway::Models::UpdateApiDetails] update_api_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_api.rb.html) to see an example of how to use update_api
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 1368 def update_api(api_id, update_api_details, opts = {}) logger.debug 'Calling operation ApiGatewayClient#update_api.' if logger raise "Missing the required parameter 'api_id' when calling update_api." if api_id.nil? raise "Missing the required parameter 'update_api_details' when calling update_api." if update_api_details.nil? raise "Parameter value for 'api_id' must not be blank" if OCI::Internal::Util.blank_string?(api_id) path = '/apis/{apiId}'.sub('{apiId}', api_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_api_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#update_api') 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
Updates a certificate with the given identifier @param [String] certificate_id The ocid of the certificate. @param [OCI::Apigateway::Models::UpdateCertificateDetails] update_certificate_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_certificate.rb.html) to see an example of how to use update_certificate
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 1430 def update_certificate(certificate_id, update_certificate_details, opts = {}) logger.debug 'Calling operation ApiGatewayClient#update_certificate.' if logger raise "Missing the required parameter 'certificate_id' when calling update_certificate." if certificate_id.nil? raise "Missing the required parameter 'update_certificate_details' when calling update_certificate." if update_certificate_details.nil? raise "Parameter value for 'certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(certificate_id) path = '/certificates/{certificateId}'.sub('{certificateId}', certificate_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_certificate_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#update_certificate') 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
Updates the SDK with the given identifier. @param [String] sdk_id The ocid of the SDK. @param [OCI::Apigateway::Models::UpdateSdkDetails] update_sdk_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_sdk.rb.html) to see an example of how to use update_sdk
API.
# File lib/oci/apigateway/api_gateway_client.rb, line 1492 def update_sdk(sdk_id, update_sdk_details, opts = {}) logger.debug 'Calling operation ApiGatewayClient#update_sdk.' if logger raise "Missing the required parameter 'sdk_id' when calling update_sdk." if sdk_id.nil? raise "Missing the required parameter 'update_sdk_details' when calling update_sdk." if update_sdk_details.nil? raise "Parameter value for 'sdk_id' must not be blank" if OCI::Internal::Util.blank_string?(sdk_id) path = '/sdks/{sdkId}'.sub('{sdkId}', sdk_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_sdk_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApiGatewayClient#update_sdk') 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
rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines
# File lib/oci/apigateway/api_gateway_client.rb, line 1536 def applicable_retry_config(opts = {}) return @retry_config unless opts.key?(:retry_config) opts[:retry_config] end