class OCI::ComputeInstanceAgent::PluginClient
API for the Oracle Cloud Agent software running on compute instances. Oracle Cloud Agent is a lightweight process that monitors and manages compute instances.
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 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.
@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/compute_instance_agent/plugin_client.rb, line 54 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
Public Instance Methods
The API to get information for a plugin. @param [String] instanceagent_id The OCID of the instance. @param [String] compartment_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. @param [String] plugin_name The name of the plugin. @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 Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
please provide the request ID.
@return [Response] A Response
object with data of type {OCI::ComputeInstanceAgent::Models::InstanceAgentPlugin InstanceAgentPlugin} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/computeinstanceagent/get_instance_agent_plugin.rb.html) to see an example of how to use get_instance_agent_plugin
API.
# File lib/oci/compute_instance_agent/plugin_client.rb, line 114 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.make_retrying_call(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
The API to get one or more plugin information. @param [String] compartment_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. @param [String] instanceagent_id The OCID of the instance. @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 Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
please provide the request ID.
@option opts [String] :status The plugin status
Allowed values are: RUNNING, STOPPED, NOT_SUPPORTED, INVALID
@option opts [String] :page For list pagination. The value of the `opc-next-page` response header from the previous "List"
call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
@option opts [Integer] :limit For list pagination. The maximum number of results per page, or items to return in a paginated
\"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 1)
@option opts [String] :sort_by The field to sort by. You can provide one sort order (`sortOrder`). Default order for
`TIMECREATED` is descending. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: TIMECREATED, DISPLAYNAME
@option opts [String] :sort_order The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order
is case sensitive. Allowed values are: ASC, DESC
@option opts [String] :name The plugin name @return [Response] A Response
object with data of type Array<{OCI::ComputeInstanceAgent::Models::InstanceAgentPluginSummary InstanceAgentPluginSummary}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/computeinstanceagent/list_instance_agent_plugins.rb.html) to see an example of how to use list_instance_agent_plugins
API.
# File lib/oci/compute_instance_agent/plugin_client.rb, line 199 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.make_retrying_call(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
@return [Logger] The logger for this client. May be nil.
# File lib/oci/compute_instance_agent/plugin_client.rb, line 93 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/compute_instance_agent/plugin_client.rb, line 83 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://iaas.{region}.{secondLevelDomain}') + '/20180530' logger.info "PluginClient endpoint set to '#{@endpoint} from region #{@region}'." if logger 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/compute_instance_agent/plugin_client.rb, line 262 def applicable_retry_config(opts = {}) return @retry_config unless opts.key?(:retry_config) opts[:retry_config] end