Class: OCI::ComputeInstanceAgent::PluginClient
- Inherits:
-
Object
- Object
- OCI::ComputeInstanceAgent::PluginClient
- Defined in:
- lib/oci/compute_instance_agent/plugin_client.rb
Overview
API for the Oracle Cloud Agent software running on compute instances. Oracle Cloud Agent is a lightweight process that monitors and manages compute instances.
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_instance_agent_plugin(instanceagent_id, compartment_id, plugin_name, opts = {}) ⇒ Response
The API to get information for a plugin.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ PluginClient
constructor
Creates a new PluginClient.
-
#list_instance_agent_plugins(compartment_id, instanceagent_id, opts = {}) ⇒ Response
The API to get one or more plugin information.
-
#logger ⇒ Logger
The logger for this client.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ PluginClient
Creates a new PluginClient. 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.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/oci/compute_instance_agent/plugin_client.rb', line 56 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 + '/20180530' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "PluginClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
16 17 18 |
# File 'lib/oci/compute_instance_agent/plugin_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/compute_instance_agent/plugin_client.rb', line 20 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
30 31 32 |
# File 'lib/oci/compute_instance_agent/plugin_client.rb', line 30 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
26 27 28 |
# File 'lib/oci/compute_instance_agent/plugin_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#get_instance_agent_plugin(instanceagent_id, compartment_id, plugin_name, opts = {}) ⇒ Response
Click here to see an example of how to use get_instance_agent_plugin API.
The API to get information for a plugin.
116 117 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 155 156 |
# File 'lib/oci/compute_instance_agent/plugin_client.rb', line 116 def get_instance_agent_plugin(instanceagent_id, compartment_id, plugin_name, opts = {}) logger.debug 'Calling operation PluginClient#get_instance_agent_plugin.' if logger raise "Missing the required parameter 'instanceagent_id' when calling get_instance_agent_plugin." if instanceagent_id.nil? raise "Missing the required parameter 'compartment_id' when calling get_instance_agent_plugin." if compartment_id.nil? raise "Missing the required parameter 'plugin_name' when calling get_instance_agent_plugin." if plugin_name.nil? raise "Parameter value for 'instanceagent_id' must not be blank" if OCI::Internal::Util.blank_string?(instanceagent_id) raise "Parameter value for 'plugin_name' must not be blank" if OCI::Internal::Util.blank_string?(plugin_name) path = '/instanceagents/{instanceagentId}/plugins/{pluginName}'.sub('{instanceagentId}', instanceagent_id.to_s).sub('{pluginName}', plugin_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_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.(applicable_retry_config(opts), call_name: 'PluginClient#get_instance_agent_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::ComputeInstanceAgent::Models::InstanceAgentPlugin' ) end # rubocop:enable Metrics/BlockLength end |
#list_instance_agent_plugins(compartment_id, instanceagent_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_instance_agent_plugins API.
The API to get one or more plugin information.
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 254 255 256 257 |
# File 'lib/oci/compute_instance_agent/plugin_client.rb', line 201 def list_instance_agent_plugins(compartment_id, instanceagent_id, opts = {}) logger.debug 'Calling operation PluginClient#list_instance_agent_plugins.' if logger raise "Missing the required parameter 'compartment_id' when calling list_instance_agent_plugins." if compartment_id.nil? raise "Missing the required parameter 'instanceagent_id' when calling list_instance_agent_plugins." if instanceagent_id.nil? if opts[:status] && !%w[RUNNING STOPPED NOT_SUPPORTED INVALID].include?(opts[:status]) raise 'Invalid value for "status", must be one of RUNNING, STOPPED, NOT_SUPPORTED, INVALID.' 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 if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'instanceagent_id' must not be blank" if OCI::Internal::Util.blank_string?(instanceagent_id) path = '/instanceagents/{instanceagentId}/plugins'.sub('{instanceagentId}', instanceagent_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:status] = opts[:status] if opts[:status] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:name] = opts[:name] if opts[:name] # 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: 'PluginClient#list_instance_agent_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: 'Array<OCI::ComputeInstanceAgent::Models::InstanceAgentPluginSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/compute_instance_agent/plugin_client.rb', line 95 def logger @api_client.config.logger end |