oraclebmc 1.2.4 → 2.0.0

data/lib/oraclebmc/core/blockstorage_client.rb

@@ -1,460 +0,0 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
-
-require "uri"
-require "logger"
-
-module OracleBMC
-
-  class Core::BlockstorageClient
-
-    # Client used to make HTTP requests.
-    # @return [OracleBMC::ApiClient]
-    attr_reader :api_client
-
-    # Fully qualified endpoint URL
-    # @return [String]
-    attr_reader :endpoint
-
-    # The region, which will usually correspond to a value in {OracleBMC::Regions::REGION_ENUM}.
-    # @return [String]
-    attr_accessor :region
-
-    # Creates a new BlockstorageClient.
-    # If a config is not specified, then the global OracleBMC.config will be used.
-    #
-    # A region must be specified in either the config 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 {OracleBMC::Regions::REGION_ENUM}, but may be an arbitrary string.
-    #
-    def initialize(config:nil, region:nil)
-      config ||= OracleBMC.config
-      signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase)
-      @api_client = ApiClient.new(config, signer)
-
-      region ||= config.region
-      self.region = region
-    end
-
-    # Set the region that will be used to determine the service endpoint.
-    # This will usually correspond to a value in {OracleBMC::Regions::REGION_ENUM},
-    # but may be an arbitrary string.
-    def region=(r)
-      @region = r
-
-      fail 'A region must be specified.' unless @region
-
-      @endpoint = OracleBMC::Regions.get_service_endpoint(@region, :BlockstorageClient) + '/20160918'
-      logger.info "BlockstorageClient endpoint set to '#{endpoint}'." if logger
-    end
-
-    # @return [Logger] The logger for this client. May be nil.
-    def logger
-      @api_client.config.logger
-    end
-
-
-    # Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from
-    # 50 GB (51200 MB) to 2 TB (2097152 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB).
-    # For general information about block volumes, see
-    # [Overview of Block Volume Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm).
-    # 
-    # A volume and instance can be in separate compartments but must be in the same Availability Domain.
-    # For information about access control and compartments, see
-    # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about
-    # Availability Domains, see [Regions and Availability Domains](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm).
-    # To get a list of Availability Domains, use the `ListAvailabilityDomains` operation
-    # in the Identity and Access Management Service API.
-    # 
-    # You may optionally specify a *display name* for the volume, which is simply a friendly name or
-    # description. It does not have to be unique, and you can change it. Avoid entering confidential information.
-    # 
-    # @param [CreateVolumeDetails] create_volume_details Request to create a new volume.
-    # @param [Hash] opts the optional parameters
-    # @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 (e.g., if a resource
-    #   has been deleted and purged from the system, then a retry of the original creation request
-    #   may be rejected).
-    #   
-    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Volume
-    def create_volume(create_volume_details, opts = {})
-      logger.debug "Calling operation BlockstorageClient#create_volume." if logger
-
-      fail "Missing the required parameter 'create_volume_details' when calling create_volume." if create_volume_details.nil?
-
-      path = "/volumes"
-
-      # 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']
-
-      post_body = @api_client.object_to_http_body(create_volume_details)
-
-      return @api_client.call_api(
-        :POST,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => 'OracleBMC::Core::Models::Volume')
-    end
-
-    # Creates a new backup of the specified volume. For general information about volume backups,
-    # see [Overview of Block Volume Service Backups](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/blockvolumebackups.htm)
-    # 
-    # When the request is received, the backup object is in a REQUEST_RECEIVED state.
-    # When the data is imaged, it goes into a CREATING state.
-    # After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.
-    # 
-    # @param [CreateVolumeBackupDetails] create_volume_backup_details Request to create a new backup of given volume.
-    # @param [Hash] opts the optional parameters
-    # @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 (e.g., if a resource
-    #   has been deleted and purged from the system, then a retry of the original creation request
-    #   may be rejected).
-    #   
-    # @return [Response] A Response object with data of type OracleBMC::Core::Models::VolumeBackup
-    def create_volume_backup(create_volume_backup_details, opts = {})
-      logger.debug "Calling operation BlockstorageClient#create_volume_backup." if logger
-
-      fail "Missing the required parameter 'create_volume_backup_details' when calling create_volume_backup." if create_volume_backup_details.nil?
-
-      path = "/volumeBackups"
-
-      # 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']
-
-      post_body = @api_client.object_to_http_body(create_volume_backup_details)
-
-      return @api_client.call_api(
-        :POST,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => 'OracleBMC::Core::Models::VolumeBackup')
-    end
-
-    # Deletes the specified volume. The volume cannot have an active connection to an instance.
-    # To disconnect the volume from a connected instance, see
-    # [Disconnecting From a Volume](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Tasks/disconnectingfromavolume.htm).
-    # **Warning:** All data on the volume will be permanently lost when the volume is deleted.
-    # 
-    # @param [String] volume_id The OCID of the volume.
-    # @param [Hash] opts the optional parameters
-    # @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
-    def delete_volume(volume_id, opts = {})
-      logger.debug "Calling operation BlockstorageClient#delete_volume." if logger
-
-      fail "Missing the required parameter 'volume_id' when calling delete_volume." if volume_id.nil?
-
-      path = "/volumes/{volumeId}".sub('{volumeId}', volume_id.to_s)
-
-      # 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']
-
-      post_body = nil
-
-      return @api_client.call_api(
-        :DELETE,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body)
-    end
-
-    # Deletes a volume backup.
-    # @param [String] volume_backup_id The OCID of the volume backup.
-    # @param [Hash] opts the optional parameters
-    # @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
-    def delete_volume_backup(volume_backup_id, opts = {})
-      logger.debug "Calling operation BlockstorageClient#delete_volume_backup." if logger
-
-      fail "Missing the required parameter 'volume_backup_id' when calling delete_volume_backup." if volume_backup_id.nil?
-
-      path = "/volumeBackups/{volumeBackupId}".sub('{volumeBackupId}', volume_backup_id.to_s)
-
-      # 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']
-
-      post_body = nil
-
-      return @api_client.call_api(
-        :DELETE,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body)
-    end
-
-    # Gets information for the specified volume.
-    # @param [String] volume_id The OCID of the volume.
-    # @param [Hash] opts the optional parameters
-    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Volume
-    def get_volume(volume_id, opts = {})
-      logger.debug "Calling operation BlockstorageClient#get_volume." if logger
-
-      fail "Missing the required parameter 'volume_id' when calling get_volume." if volume_id.nil?
-
-      path = "/volumes/{volumeId}".sub('{volumeId}', volume_id.to_s)
-
-      # Query Params
-      query_params = {}
-
-      # Header Params
-      header_params = {}
-      header_params['accept'] = 'application/json'
-      header_params['content-type'] = 'application/json'
-
-      post_body = nil
-
-      return @api_client.call_api(
-        :GET,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => 'OracleBMC::Core::Models::Volume')
-    end
-
-    # Gets information for the specified volume backup.
-    # @param [String] volume_backup_id The OCID of the volume backup.
-    # @param [Hash] opts the optional parameters
-    # @return [Response] A Response object with data of type OracleBMC::Core::Models::VolumeBackup
-    def get_volume_backup(volume_backup_id, opts = {})
-      logger.debug "Calling operation BlockstorageClient#get_volume_backup." if logger
-
-      fail "Missing the required parameter 'volume_backup_id' when calling get_volume_backup." if volume_backup_id.nil?
-
-      path = "/volumeBackups/{volumeBackupId}".sub('{volumeBackupId}', volume_backup_id.to_s)
-
-      # Query Params
-      query_params = {}
-
-      # Header Params
-      header_params = {}
-      header_params['accept'] = 'application/json'
-      header_params['content-type'] = 'application/json'
-
-      post_body = nil
-
-      return @api_client.call_api(
-        :GET,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => 'OracleBMC::Core::Models::VolumeBackup')
-    end
-
-    # Lists the volume backups in the specified compartment. You can filter the results by volume.
-    # 
-    # @param [String] compartment_id The OCID of the compartment.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :volume_id The OCID of the volume.
-    # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
-    #   
-    #   Example: `500`
-    #   
-    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
-    #   
-    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::VolumeBackup>
-    def list_volume_backups(compartment_id, opts = {})
-      logger.debug "Calling operation BlockstorageClient#list_volume_backups." if logger
-
-      fail "Missing the required parameter 'compartment_id' when calling list_volume_backups." if compartment_id.nil?
-
-      path = "/volumeBackups"
-
-      # Query Params
-      query_params = {}
-      query_params[:'compartmentId'] = compartment_id
-      query_params[:'volumeId'] = opts[:'volume_id'] if opts[:'volume_id']
-      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
-      query_params[:'page'] = opts[:'page'] if opts[:'page']
-
-      # Header Params
-      header_params = {}
-      header_params['accept'] = 'application/json'
-      header_params['content-type'] = 'application/json'
-
-      post_body = nil
-
-      return @api_client.call_api(
-        :GET,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => 'Array<OracleBMC::Core::Models::VolumeBackup>')
-    end
-
-    # Lists the volumes in the specified compartment and Availability Domain.
-    # 
-    # @param [String] compartment_id The OCID of the compartment.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :availability_domain The name of the Availability Domain.
-    #   
-    #   Example: `Uocm:PHX-AD-1`
-    #   
-    # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
-    #   
-    #   Example: `500`
-    #   
-    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
-    #   
-    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::Volume>
-    def list_volumes(compartment_id, opts = {})
-      logger.debug "Calling operation BlockstorageClient#list_volumes." if logger
-
-      fail "Missing the required parameter 'compartment_id' when calling list_volumes." if compartment_id.nil?
-
-      path = "/volumes"
-
-      # Query Params
-      query_params = {}
-      query_params[:'compartmentId'] = compartment_id
-      query_params[:'availabilityDomain'] = opts[:'availability_domain'] if opts[:'availability_domain']
-      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
-      query_params[:'page'] = opts[:'page'] if opts[:'page']
-
-      # Header Params
-      header_params = {}
-      header_params['accept'] = 'application/json'
-      header_params['content-type'] = 'application/json'
-
-      post_body = nil
-
-      return @api_client.call_api(
-        :GET,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => 'Array<OracleBMC::Core::Models::Volume>')
-    end
-
-    # Updates the specified volume's display name.
-    # Avoid entering confidential information.
-    # 
-    # @param [String] volume_id The OCID of the volume.
-    # @param [UpdateVolumeDetails] update_volume_details Update volume's display name. Avoid entering confidential information.
-    # @param [Hash] opts the optional parameters
-    # @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 OracleBMC::Core::Models::Volume
-    def update_volume(volume_id, update_volume_details, opts = {})
-      logger.debug "Calling operation BlockstorageClient#update_volume." if logger
-
-      fail "Missing the required parameter 'volume_id' when calling update_volume." if volume_id.nil?
-      fail "Missing the required parameter 'update_volume_details' when calling update_volume." if update_volume_details.nil?
-
-      path = "/volumes/{volumeId}".sub('{volumeId}', volume_id.to_s)
-
-      # 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']
-
-      post_body = @api_client.object_to_http_body(update_volume_details)
-
-      return @api_client.call_api(
-        :PUT,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => 'OracleBMC::Core::Models::Volume')
-    end
-
-    # Updates the display name for the specified volume backup.
-    # Avoid entering confidential information.
-    # 
-    # @param [String] volume_backup_id The OCID of the volume backup.
-    # @param [UpdateVolumeBackupDetails] update_volume_backup_details Update volume backup fields
-    # @param [Hash] opts the optional parameters
-    # @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 OracleBMC::Core::Models::VolumeBackup
-    def update_volume_backup(volume_backup_id, update_volume_backup_details, opts = {})
-      logger.debug "Calling operation BlockstorageClient#update_volume_backup." if logger
-
-      fail "Missing the required parameter 'volume_backup_id' when calling update_volume_backup." if volume_backup_id.nil?
-      fail "Missing the required parameter 'update_volume_backup_details' when calling update_volume_backup." if update_volume_backup_details.nil?
-
-      path = "/volumeBackups/{volumeBackupId}".sub('{volumeBackupId}', volume_backup_id.to_s)
-
-      # 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']
-
-      post_body = @api_client.object_to_http_body(update_volume_backup_details)
-
-      return @api_client.call_api(
-        :PUT,
-        path,
-        endpoint,
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => 'OracleBMC::Core::Models::VolumeBackup')
-    end
-  end
-end