Class: OCI::Rover::RoverEntitlementClient
- Inherits:
-
Object
- Object
- OCI::Rover::RoverEntitlementClient
- Defined in:
- lib/oci/rover/rover_entitlement_client.rb
Overview
A description of the RoverCloudService API.
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 OCI::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
-
#change_rover_entitlement_compartment(rover_entitlement_id, change_rover_entitlement_compartment_details, opts = {}) ⇒ Response
Moves an entitlement into a different compartment.
-
#create_rover_entitlement(create_rover_entitlement_details, opts = {}) ⇒ Response
Create the Entitlement to use a Rover Device.
-
#delete_rover_entitlement(rover_entitlement_id, opts = {}) ⇒ Response
Deletes a rover entitlement.
-
#get_rover_entitlement(rover_entitlement_id, compartment_id, opts = {}) ⇒ Response
Describes the Rover Device Entitlement in detail.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ RoverEntitlementClient
constructor
Creates a new RoverEntitlementClient.
-
#list_rover_entitlements(compartment_id, opts = {}) ⇒ Response
Returns a list of RoverEntitlements.
-
#logger ⇒ Logger
The logger for this client.
-
#update_rover_entitlement(rover_entitlement_id, update_rover_entitlement_details, opts = {}) ⇒ Response
Updates the RoverEntitlement.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ RoverEntitlementClient
Creates a new RoverEntitlementClient. 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/rover/rover_entitlement_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 + '/20201210' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "RoverEntitlementClient 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/rover/rover_entitlement_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/rover/rover_entitlement_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in OCI::Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/rover/rover_entitlement_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/rover/rover_entitlement_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#change_rover_entitlement_compartment(rover_entitlement_id, change_rover_entitlement_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_rover_entitlement_compartment API.
Moves an entitlement into a different compartment.
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 157 158 159 160 161 162 163 |
# File 'lib/oci/rover/rover_entitlement_client.rb', line 124 def change_rover_entitlement_compartment(rover_entitlement_id, change_rover_entitlement_compartment_details, opts = {}) logger.debug 'Calling operation RoverEntitlementClient#change_rover_entitlement_compartment.' if logger raise "Missing the required parameter 'rover_entitlement_id' when calling change_rover_entitlement_compartment." if rover_entitlement_id.nil? raise "Missing the required parameter 'change_rover_entitlement_compartment_details' when calling change_rover_entitlement_compartment." if change_rover_entitlement_compartment_details.nil? raise "Parameter value for 'rover_entitlement_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_entitlement_id) path = '/roverEntitlements/{roverEntitlementId}/actions/changeCompartment'.sub('{roverEntitlementId}', rover_entitlement_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_rover_entitlement_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverEntitlementClient#change_rover_entitlement_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 |
#create_rover_entitlement(create_rover_entitlement_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_rover_entitlement API.
Create the Entitlement to use a Rover Device. It requires some offline process of review and signatures before request is granted.
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 |
# File 'lib/oci/rover/rover_entitlement_client.rb', line 187 def create_rover_entitlement(create_rover_entitlement_details, opts = {}) logger.debug 'Calling operation RoverEntitlementClient#create_rover_entitlement.' if logger raise "Missing the required parameter 'create_rover_entitlement_details' when calling create_rover_entitlement." if create_rover_entitlement_details.nil? path = '/roverEntitlements' 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_rover_entitlement_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverEntitlementClient#create_rover_entitlement') 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::Rover::Models::RoverEntitlement' ) end # rubocop:enable Metrics/BlockLength end |
#delete_rover_entitlement(rover_entitlement_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_rover_entitlement API.
Deletes a rover entitlement
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/oci/rover/rover_entitlement_client.rb', line 254 def delete_rover_entitlement(rover_entitlement_id, opts = {}) logger.debug 'Calling operation RoverEntitlementClient#delete_rover_entitlement.' if logger raise "Missing the required parameter 'rover_entitlement_id' when calling delete_rover_entitlement." if rover_entitlement_id.nil? raise "Parameter value for 'rover_entitlement_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_entitlement_id) path = '/roverEntitlements/{roverEntitlementId}'.sub('{roverEntitlementId}', rover_entitlement_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[:'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 header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverEntitlementClient#delete_rover_entitlement') 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 |
#get_rover_entitlement(rover_entitlement_id, compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_rover_entitlement API.
Describes the Rover Device Entitlement in detail
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/oci/rover/rover_entitlement_client.rb', line 317 def get_rover_entitlement(rover_entitlement_id, compartment_id, opts = {}) logger.debug 'Calling operation RoverEntitlementClient#get_rover_entitlement.' if logger raise "Missing the required parameter 'rover_entitlement_id' when calling get_rover_entitlement." if rover_entitlement_id.nil? raise "Missing the required parameter 'compartment_id' when calling get_rover_entitlement." if compartment_id.nil? raise "Parameter value for 'rover_entitlement_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_entitlement_id) path = '/roverEntitlements/{roverEntitlementId}'.sub('{roverEntitlementId}', rover_entitlement_id.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-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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverEntitlementClient#get_rover_entitlement') 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::Rover::Models::RoverEntitlement' ) end # rubocop:enable Metrics/BlockLength end |
#list_rover_entitlements(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_rover_entitlements API.
Returns a list of RoverEntitlements. Allowed values are: timeCreated, displayName
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/oci/rover/rover_entitlement_client.rb', line 384 def list_rover_entitlements(compartment_id, opts = {}) logger.debug 'Calling operation RoverEntitlementClient#list_rover_entitlements.' if logger raise "Missing the required parameter 'compartment_id' when calling list_rover_entitlements." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Rover::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Rover::Models::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::Rover::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::Rover::Models::SORT_ORDERS_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 = '/roverEntitlements' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:id] = opts[:id] if opts[: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.(applicable_retry_config(opts), call_name: 'RoverEntitlementClient#list_rover_entitlements') 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::Rover::Models::RoverEntitlementCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/rover/rover_entitlement_client.rb', line 94 def logger @api_client.config.logger end |
#update_rover_entitlement(rover_entitlement_id, update_rover_entitlement_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_rover_entitlement API.
Updates the RoverEntitlement
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 |
# File 'lib/oci/rover/rover_entitlement_client.rb', line 464 def update_rover_entitlement(rover_entitlement_id, update_rover_entitlement_details, opts = {}) logger.debug 'Calling operation RoverEntitlementClient#update_rover_entitlement.' if logger raise "Missing the required parameter 'rover_entitlement_id' when calling update_rover_entitlement." if rover_entitlement_id.nil? raise "Missing the required parameter 'update_rover_entitlement_details' when calling update_rover_entitlement." if update_rover_entitlement_details.nil? raise "Parameter value for 'rover_entitlement_id' must not be blank" if OCI::Internal::Util.blank_string?(rover_entitlement_id) path = '/roverEntitlements/{roverEntitlementId}'.sub('{roverEntitlementId}', rover_entitlement_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_rover_entitlement_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RoverEntitlementClient#update_rover_entitlement') 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, return_type: 'OCI::Rover::Models::RoverEntitlement' ) end # rubocop:enable Metrics/BlockLength end |