Class: OCI::Sch::ConnectorPluginsClient
- Inherits:
-
Object
- Object
- OCI::Sch::ConnectorPluginsClient
- Defined in:
- lib/oci/sch/connector_plugins_client.rb
Overview
Use the Connector Hub API to transfer data between services in Oracle Cloud Infrastructure. For more information about Connector Hub, see the Connector Hub documentation. Connector Hub is formerly known as Service Connector Hub.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#get_connector_plugin(connector_plugin_name, opts = {}) ⇒ Response
Gets the specified connector plugin configuration information.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ConnectorPluginsClient
constructor
Creates a new ConnectorPluginsClient.
-
#list_connector_plugins(opts = {}) ⇒ Response
Lists connector plugins according to the specified filter.
-
#logger ⇒ Logger
The logger for this client.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ConnectorPluginsClient
Creates a new ConnectorPluginsClient. 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.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/oci/sch/connector_plugins_client.rb', line 58 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 + '/20200909' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ConnectorPluginsClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
18 19 20 |
# File 'lib/oci/sch/connector_plugins_client.rb', line 18 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
22 23 24 |
# File 'lib/oci/sch/connector_plugins_client.rb', line 22 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
32 33 34 |
# File 'lib/oci/sch/connector_plugins_client.rb', line 32 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
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
28 29 30 |
# File 'lib/oci/sch/connector_plugins_client.rb', line 28 def retry_config @retry_config end |
Instance Method Details
#get_connector_plugin(connector_plugin_name, opts = {}) ⇒ Response
Click here to see an example of how to use get_connector_plugin API.
Gets the specified connector plugin configuration information.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/oci/sch/connector_plugins_client.rb', line 118 def get_connector_plugin(connector_plugin_name, opts = {}) logger.debug 'Calling operation ConnectorPluginsClient#get_connector_plugin.' if logger raise "Missing the required parameter 'connector_plugin_name' when calling get_connector_plugin." if connector_plugin_name.nil? raise "Parameter value for 'connector_plugin_name' must not be blank" if OCI::Internal::Util.blank_string?(connector_plugin_name) path = '/connectorPlugins/{connectorPluginName}'.sub('{connectorPluginName}', connector_plugin_name.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.(applicable_retry_config(opts), call_name: 'ConnectorPluginsClient#get_connector_plugin') 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::Sch::Models::ConnectorPlugin' ) end # rubocop:enable Metrics/BlockLength end |
#list_connector_plugins(opts = {}) ⇒ Response
Click here to see an example of how to use list_connector_plugins API.
Lists connector plugins according to the specified filter.
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/oci/sch/connector_plugins_client.rb', line 200 def list_connector_plugins(opts = {}) logger.debug 'Calling operation ConnectorPluginsClient#list_connector_plugins.' if logger if opts[:lifecycle_state] && !OCI::Sch::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Sch::Models::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::Sch::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::Sch::Models::SORT_ORDER_ENUM.' 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 = '/connectorPlugins' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:name] = opts[:name] if opts[: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.(applicable_retry_config(opts), call_name: 'ConnectorPluginsClient#list_connector_plugins') 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::Sch::Models::ConnectorPluginCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
97 98 99 |
# File 'lib/oci/sch/connector_plugins_client.rb', line 97 def logger @api_client.config.logger end |