class OCI::Rover::RoverEntitlementClient
A description of the RoverCloudService API.
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 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.
@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/rover/rover_entitlement_client.rb, line 53 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
Public Instance Methods
Moves an entitlement into a different compartment. @param [String] rover_entitlement_id ID of the rover node or cluster entitlement @param [OCI::Rover::Models::ChangeRoverEntitlementCompartmentDetails] change_rover_entitlement_compartment_details CompartmentId of the destination compartment @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] :if_match For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
@option opts [String] :opc_request_id The client request ID for tracing. @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
@return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/rover/change_rover_entitlement_compartment.rb.html) to see an example of how to use change_rover_entitlement_compartment
API.
# File lib/oci/rover/rover_entitlement_client.rb, line 122 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.make_retrying_call(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 the Entitlement to use a Rover
Device. It requires some offline process of review and signatures before request is granted. @param [OCI::Rover::Models::CreateRoverEntitlementDetails] create_rover_entitlement_details Creates a Rover
Device Entitlement @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_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::Rover::Models::RoverEntitlement RoverEntitlement} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/rover/create_rover_entitlement.rb.html) to see an example of how to use create_rover_entitlement
API.
# File lib/oci/rover/rover_entitlement_client.rb, line 185 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.make_retrying_call(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
Deletes a rover entitlement @param [String] rover_entitlement_id ID of the rover node or cluster entitlement @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_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
@return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/rover/delete_rover_entitlement.rb.html) to see an example of how to use delete_rover_entitlement
API.
# File lib/oci/rover/rover_entitlement_client.rb, line 252 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.make_retrying_call(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
Describes the Rover
Device Entitlement in detail @param [String] rover_entitlement_id ID of the rover node or cluster entitlement @param [String] compartment_id The OCID of the compartment in which to list resources. @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_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::Rover::Models::RoverEntitlement RoverEntitlement} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/rover/get_rover_entitlement.rb.html) to see an example of how to use get_rover_entitlement
API.
# File lib/oci/rover/rover_entitlement_client.rb, line 315 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.make_retrying_call(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
Returns a list of RoverEntitlements. @param [String] compartment_id The OCID of the compartment in which to list resources. @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] :id filtering by Rover
Device Entitlement id @option opts [String] :display_name A filter to return only resources that match the entire display name given. @option opts [String] :lifecycle_state A filter to return only resources their lifecycleState matches the given lifecycleState. @option opts [Integer] :limit The maximum number of items to return. (default to 10) @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. (default to ASC) @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
(default to timeCreated) Allowed values are: timeCreated, displayName
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::Rover::Models::RoverEntitlementCollection RoverEntitlementCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/rover/list_rover_entitlements.rb.html) to see an example of how to use list_rover_entitlements
API.
# File lib/oci/rover/rover_entitlement_client.rb, line 382 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.make_retrying_call(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
@return [Logger] The logger for this client. May be nil.
# File lib/oci/rover/rover_entitlement_client.rb, line 92 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/rover/rover_entitlement_client.rb, line 82 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://rover.{region}.oci.{secondLevelDomain}') + '/20201210' logger.info "RoverEntitlementClient endpoint set to '#{@endpoint} from region #{@region}'." if logger end
Updates the RoverEntitlement @param [String] rover_entitlement_id ID of the rover node or cluster entitlement @param [OCI::Rover::Models::UpdateRoverEntitlementDetails] update_rover_entitlement_details The information to be updated. @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] :if_match For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::Rover::Models::RoverEntitlement RoverEntitlement} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/rover/update_rover_entitlement.rb.html) to see an example of how to use update_rover_entitlement
API.
# File lib/oci/rover/rover_entitlement_client.rb, line 462 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.make_retrying_call(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
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/rover/rover_entitlement_client.rb, line 507 def applicable_retry_config(opts = {}) return @retry_config unless opts.key?(:retry_config) opts[:retry_config] end