Class: OCI::Onesubscription::CommitmentClient
- Inherits:
-
Object
- Object
- OCI::Onesubscription::CommitmentClient
- Defined in:
- lib/oci/onesubscription/commitment_client.rb
Overview
OneSubscription APIs
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_commitment(commitment_id, opts = {}) ⇒ Response
This API returns the commitment details corresponding to the id provided.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ CommitmentClient
constructor
Creates a new CommitmentClient.
-
#list_commitments(subscribed_service_id, compartment_id, opts = {}) ⇒ Response
This list API returns all commitments for a particular Subscribed Service.
-
#logger ⇒ Logger
The logger for this client.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ CommitmentClient
Creates a new CommitmentClient. 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.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/onesubscription/commitment_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 + '/20190111' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "CommitmentClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/onesubscription/commitment_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/onesubscription/commitment_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/onesubscription/commitment_client.rb', line 29 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
25 26 27 |
# File 'lib/oci/onesubscription/commitment_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#get_commitment(commitment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_commitment API.
This API returns the commitment details corresponding to the id provided
113 114 115 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 |
# File 'lib/oci/onesubscription/commitment_client.rb', line 113 def get_commitment(commitment_id, opts = {}) logger.debug 'Calling operation CommitmentClient#get_commitment.' if logger raise "Missing the required parameter 'commitment_id' when calling get_commitment." if commitment_id.nil? raise "Parameter value for 'commitment_id' must not be blank" if OCI::Internal::Util.blank_string?(commitment_id) path = '/commitments/{commitmentId}'.sub('{commitmentId}', commitment_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.(applicable_retry_config(opts), call_name: 'CommitmentClient#get_commitment') 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::Onesubscription::Models::Commitment' ) end # rubocop:enable Metrics/BlockLength end |
#list_commitments(subscribed_service_id, compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_commitments API.
This list API returns all commitments for a particular Subscribed Service
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 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 |
# File 'lib/oci/onesubscription/commitment_client.rb', line 183 def list_commitments(subscribed_service_id, compartment_id, opts = {}) logger.debug 'Calling operation CommitmentClient#list_commitments.' if logger raise "Missing the required parameter 'subscribed_service_id' when calling list_commitments." if subscribed_service_id.nil? raise "Missing the required parameter 'compartment_id' when calling list_commitments." 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[ORDERNUMBER TIMEINVOICING].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of ORDERNUMBER, TIMEINVOICING.' end path = '/commitments' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:subscribedServiceId] = subscribed_service_id query_params[:compartmentId] = compartment_id 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: 'CommitmentClient#list_commitments') 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::Onesubscription::Models::CommitmentSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/onesubscription/commitment_client.rb', line 94 def logger @api_client.config.logger end |