oci 2.0.1 → 2.0.2

data/lib/oci/database/database.rb

@@ -8,14 +8,19 @@ module OCI
 end
 
 # Require models
+require 'oci/database/models/backup'
+require 'oci/database/models/backup_summary'
+require 'oci/database/models/create_backup_details'
 require 'oci/database/models/create_data_guard_association_details'
 require 'oci/database/models/create_data_guard_association_to_existing_db_system_details'
 require 'oci/database/models/create_database_details'
 require 'oci/database/models/create_db_home_details'
 require 'oci/database/models/create_db_home_with_db_system_id_details'
 require 'oci/database/models/data_guard_association'
+require 'oci/database/models/data_guard_association_summary'
 require 'oci/database/models/database'
 require 'oci/database/models/database_summary'
+require 'oci/database/models/db_backup_config'
 require 'oci/database/models/db_home'
 require 'oci/database/models/db_home_summary'
 require 'oci/database/models/db_node'
@@ -32,7 +37,9 @@ require 'oci/database/models/patch_history_entry'
 require 'oci/database/models/patch_history_entry_summary'
 require 'oci/database/models/patch_summary'
 require 'oci/database/models/reinstate_data_guard_association_details'
+require 'oci/database/models/restore_database_details'
 require 'oci/database/models/switchover_data_guard_association_details'
+require 'oci/database/models/update_database_details'
 require 'oci/database/models/update_db_home_details'
 require 'oci/database/models/update_db_system_details'
 

data/lib/oci/database/database_client.rb

@@ -33,7 +33,7 @@ module OCI
       config ||= OCI.config
       config.validate
 
-      signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::OBJECT_STORAGE)
+      signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::STANDARD)
       @api_client = ApiClient.new(config, signer)
 
       region ||= config.region
@@ -58,10 +58,49 @@ module OCI
     end
 
 
+    # Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
+    # 
+    # @param [CreateBackupDetails] create_backup_details Request to create a new database backup.
+    # @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 (for example, 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 OCI::Database::Models::Backup
+    def create_backup(create_backup_details, opts = {})
+      logger.debug "Calling operation DatabaseClient#create_backup." if logger
+
+      fail "Missing the required parameter 'create_backup_details' when calling create_backup." if create_backup_details.nil?
+
+      path = "/backups"
+
+      # 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_backup_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OCI::Database::Models::Backup')
+    end
+
     # Creates a new Data Guard association.  A Data Guard association represents the replication relationship between the
     # specified database and a peer database. For more information, see [Using Oracle Data Guard](https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Tasks/usingdataguard.htm).
     # 
-    # All Oracle Bare Metal Cloud Services resources, including Data Guard associations, get an Oracle-assigned, unique ID
+    # All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID
     # called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response.
     # You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the
     # resource in the Console. Fore more information, see
@@ -163,6 +202,7 @@ module OCI
     # 
     # @param [String] db_node_id The database node [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
     # @param [String] action The action to perform on the DB Node.
+    #   Allowed values are: STOP, START, SOFTRESET, RESET
     # @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
@@ -209,6 +249,41 @@ module OCI
         :return_type => 'OCI::Database::Models::DbNode')
     end
 
+    # Deletes a full backup. You cannot delete automatic backups using this API.
+    # @param [String] backup_id The backup OCID.
+    # @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_backup(backup_id, opts = {})
+      logger.debug "Calling operation DatabaseClient#delete_backup." if logger
+
+      fail "Missing the required parameter 'backup_id' when calling delete_backup." if backup_id.nil?
+
+      path = "/backups/{backupId}".sub('{backupId}', 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
+
     # Deletes a DB Home. The DB Home and its database data are local to the DB System and will be lost when it is deleted. Oracle recommends that you back up any data in the DB System prior to deleting it.
     # 
     # @param [String] db_home_id The database home [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
@@ -217,6 +292,7 @@ module OCI
     #   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 [BOOLEAN] :perform_final_backup Whether to perform a final backup of the database or not. Default is false. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
     # @return [Response] A Response object with data of type nil
     def delete_db_home(db_home_id, opts = {})
       logger.debug "Calling operation DatabaseClient#delete_db_home." if logger
@@ -227,6 +303,7 @@ module OCI
 
       # Query Params
       query_params = {}
+      query_params[:'performFinalBackup'] = opts[:'perform_final_backup'] if opts[:'perform_final_backup']
 
       # Header Params
       header_params = {}
@@ -290,6 +367,37 @@ module OCI
         :return_type => 'OCI::Database::Models::DataGuardAssociation')
     end
 
+    # Gets information about the specified backup.
+    # @param [String] backup_id The backup OCID.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OCI::Database::Models::Backup
+    def get_backup(backup_id, opts = {})
+      logger.debug "Calling operation DatabaseClient#get_backup." if logger
+
+      fail "Missing the required parameter 'backup_id' when calling get_backup." if backup_id.nil?
+
+      path = "/backups/{backupId}".sub('{backupId}', 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 => 'OCI::Database::Models::Backup')
+    end
+
     # Gets the specified Data Guard association's configuration information.
     # 
     # @param [String] database_id The database [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
@@ -632,13 +740,51 @@ module OCI
         :return_type => 'OCI::Database::Models::DbSystem')
     end
 
+    # Gets a list of backups based on the databaseId or compartmentId specified. Either one of the query parameters must be provided.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :database_id The OCID of the database.
+    # @option opts [String] :compartment_id The compartment OCID.
+    # @option opts [Integer] :limit The maximum number of items to return.
+    # @option opts [String] :page The pagination token to continue listing from.
+    # @return [Response] A Response object with data of type Array<OCI::Database::Models::BackupSummary>
+    def list_backups(opts = {})
+      logger.debug "Calling operation DatabaseClient#list_backups." if logger
+
+
+      path = "/backups"
+
+      # Query Params
+      query_params = {}
+      query_params[:'databaseId'] = opts[:'database_id'] if opts[:'database_id']
+      query_params[:'compartmentId'] = opts[:'compartment_id'] if opts[:'compartment_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<OCI::Database::Models::BackupSummary>')
+    end
+
     # Lists all Data Guard associations for the specified database.
     # 
     # @param [String] database_id The database [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit The maximum number of items to return.
     # @option opts [String] :page The pagination token to continue listing from.
-    # @return [Response] A Response object with data of type Array<OCI::Database::Models::DataGuardAssociation>
+    # @return [Response] A Response object with data of type Array<OCI::Database::Models::DataGuardAssociationSummary>
     def list_data_guard_associations(database_id, opts = {})
       logger.debug "Calling operation DatabaseClient#list_data_guard_associations." if logger
 
@@ -665,7 +811,7 @@ module OCI
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
-        :return_type => 'Array<OCI::Database::Models::DataGuardAssociation>')
+        :return_type => 'Array<OCI::Database::Models::DataGuardAssociationSummary>')
     end
 
     # Gets a list of the databases in the specified database home.
@@ -1088,6 +1234,45 @@ module OCI
         :return_type => 'OCI::Database::Models::DataGuardAssociation')
     end
 
+    # Restore a Database based on the request parameters you provide.
+    # 
+    # @param [String] database_id The database [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
+    # @param [RestoreDatabaseDetails] restore_database_details Request to perform database restore.
+    # @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 OCI::Database::Models::Database
+    def restore_database(database_id, restore_database_details, opts = {})
+      logger.debug "Calling operation DatabaseClient#restore_database." if logger
+
+      fail "Missing the required parameter 'database_id' when calling restore_database." if database_id.nil?
+      fail "Missing the required parameter 'restore_database_details' when calling restore_database." if restore_database_details.nil?
+
+      path = "/databases/{databaseId}/actions/restore".sub('{databaseId}', database_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(restore_database_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OCI::Database::Models::Database')
+    end
+
     # Performs a switchover to transition the primary database of a Data Guard association into a standby role. The
     # standby database associated with the `dataGuardAssociationId` assumes the primary database role.
     # 
@@ -1167,6 +1352,45 @@ module OCI
         :body => post_body)
     end
 
+    # Update a Database based on the request parameters you provide.
+    # 
+    # @param [String] database_id The database [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
+    # @param [UpdateDatabaseDetails] update_database_details Request to perform database update.
+    # @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 OCI::Database::Models::Database
+    def update_database(database_id, update_database_details, opts = {})
+      logger.debug "Calling operation DatabaseClient#update_database." if logger
+
+      fail "Missing the required parameter 'database_id' when calling update_database." if database_id.nil?
+      fail "Missing the required parameter 'update_database_details' when calling update_database." if update_database_details.nil?
+
+      path = "/databases/{databaseId}".sub('{databaseId}', database_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_database_details)
+
+      return @api_client.call_api(
+        :PUT,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OCI::Database::Models::Database')
+    end
+
     # Patches the specified dbHome.
     # @param [String] db_home_id The database home [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
     # @param [UpdateDbHomeDetails] update_db_home_details Request to update the properties of a DB Home.

data/lib/oci/database/models/backup.rb

@@ -0,0 +1,253 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OCI
+  class Database::Models::Backup
+
+    LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
+                LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
+                LIFECYCLE_STATE_DELETING = 'DELETING',
+                LIFECYCLE_STATE_DELETED = 'DELETED',
+                LIFECYCLE_STATE_FAILED = 'FAILED',
+                LIFECYCLE_STATE_RESTORING = 'RESTORING',
+                LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
+
+
+    TYPE_ENUM = [TYPE_INCREMENTAL = 'INCREMENTAL',
+                TYPE_FULL = 'FULL',
+                TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
+
+    # The name of the Availability Domain that the backup is located in.
+    # @return [String]
+    attr_accessor :availability_domain
+
+    # The OCID of the compartment.
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # The OCID of the database.
+    # @return [String]
+    attr_accessor :database_id
+
+    # The user-friendly name for the backup. It does not have to be unique.
+    # @return [String]
+    attr_accessor :display_name
+
+    # The OCID of the backup.
+    # @return [String]
+    attr_accessor :id
+
+    # Additional information about the current lifecycleState.
+    # @return [String]
+    attr_accessor :lifecycle_details
+
+    # The current state of the backup.
+    # @return [String]
+    attr_accessor :lifecycle_state
+
+    # The date and time the backup was completed.
+    # @return [DateTime]
+    attr_accessor :time_ended
+
+    # The date and time the backup starts.
+    # @return [DateTime]
+    attr_accessor :time_started
+
+    # The type of backup.
+    # @return [String]
+    attr_accessor :type
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes[:'availabilityDomain']
+        self.availability_domain = attributes[:'availabilityDomain']
+      end
+
+      if attributes[:'compartmentId']
+        self.compartment_id = attributes[:'compartmentId']
+      end
+
+      if attributes[:'databaseId']
+        self.database_id = attributes[:'databaseId']
+      end
+
+      if attributes[:'displayName']
+        self.display_name = attributes[:'displayName']
+      end
+
+      if attributes[:'id']
+        self.id = attributes[:'id']
+      end
+
+      if attributes[:'lifecycleDetails']
+        self.lifecycle_details = attributes[:'lifecycleDetails']
+      end
+
+      if attributes[:'lifecycleState']
+        self.lifecycle_state = attributes[:'lifecycleState']
+      end
+
+      if attributes[:'timeEnded']
+        self.time_ended = attributes[:'timeEnded']
+      end
+
+      if attributes[:'timeStarted']
+        self.time_started = attributes[:'timeStarted']
+      end
+
+      if attributes[:'type']
+        self.type = attributes[:'type']
+      end
+
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] lifecycle_state Object to be assigned
+    def lifecycle_state=(lifecycle_state)
+      if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
+        @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
+      else
+        @lifecycle_state = lifecycle_state
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      if type && !TYPE_ENUM.include?(type)
+        @type = TYPE_UNKNOWN_ENUM_VALUE
+      else
+        @type = type
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other_object to be compared
+    def ==(other_object)
+      return true if self.equal?(other_object)
+      self.class == other_object.class &&
+          availability_domain == other_object.availability_domain &&
+          compartment_id == other_object.compartment_id &&
+          database_id == other_object.database_id &&
+          display_name == other_object.display_name &&
+          id == other_object.id &&
+          lifecycle_details == other_object.lifecycle_details &&
+          lifecycle_state == other_object.lifecycle_state &&
+          time_ended == other_object.time_ended &&
+          time_started == other_object.time_started &&
+          type == other_object.type
+    end
+
+    # @see the `==` method
+    # @param [Object] other_object to be compared
+    def eql?(other_object)
+      self == other_object
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [availability_domain, compartment_id, database_id, display_name, id, lifecycle_details, lifecycle_state, time_ended, time_started, type].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = send(attr)
+        next if value.nil? && !instance_variable_defined?("@#{attr}")
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    private
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value 
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { 
+        :'availability_domain' => :'availabilityDomain',
+        :'compartment_id' => :'compartmentId',
+        :'database_id' => :'databaseId',
+        :'display_name' => :'displayName',
+        :'id' => :'id',
+        :'lifecycle_details' => :'lifecycleDetails',
+        :'lifecycle_state' => :'lifecycleState',
+        :'time_ended' => :'timeEnded',
+        :'time_started' => :'timeStarted',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'availability_domain' => :'String',
+        :'compartment_id' => :'String',
+        :'database_id' => :'String',
+        :'display_name' => :'String',
+        :'id' => :'String',
+        :'lifecycle_details' => :'String',
+        :'lifecycle_state' => :'String',
+        :'time_ended' => :'DateTime',
+        :'time_started' => :'DateTime',
+        :'type' => :'String'
+      }
+    end
+  end
+end