oci 2.3.0 → 2.3.1

data/lib/oci/core/blockstorage_client_composite_operations.rb

@@ -24,6 +24,84 @@ module OCI
     # rubocop:disable Layout/EmptyLines
 
 
+    # Calls {OCI::Core::BlockstorageClient#create_boot_volume} and then waits for the {OCI::Core::Models::BootVolume} acted upon
+    # to enter the given state(s).
+    #
+    # @param [OCI::Core::Models::CreateBootVolumeDetails] create_boot_volume_details Request to create a new boot volume.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Core::Models::BootVolume#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Core::BlockstorageClient#create_boot_volume}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object with data of type {OCI::Core::Models::BootVolume}
+    def create_boot_volume_and_wait_for_state(create_boot_volume_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.create_boot_volume(create_boot_volume_details, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+      wait_for_resource_id = operation_result.data.id
+
+      begin
+        waiter_result = @service_client.get_boot_volume(wait_for_resource_id).wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
+          max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+          max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+        )
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
+    # Calls {OCI::Core::BlockstorageClient#create_boot_volume_backup} and then waits for the {OCI::Core::Models::BootVolumeBackup} acted upon
+    # to enter the given state(s).
+    #
+    # @param [OCI::Core::Models::CreateBootVolumeBackupDetails] create_boot_volume_backup_details Request to create a new backup of given boot volume.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Core::Models::BootVolumeBackup#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Core::BlockstorageClient#create_boot_volume_backup}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object with data of type {OCI::Core::Models::BootVolumeBackup}
+    def create_boot_volume_backup_and_wait_for_state(create_boot_volume_backup_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.create_boot_volume_backup(create_boot_volume_backup_details, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+      wait_for_resource_id = operation_result.data.id
+
+      begin
+        waiter_result = @service_client.get_boot_volume_backup(wait_for_resource_id).wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
+          max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+          max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+        )
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
     # Calls {OCI::Core::BlockstorageClient#create_volume} and then waits for the {OCI::Core::Models::Volume} acted upon
     # to enter the given state(s).
     #
@@ -220,6 +298,46 @@ module OCI
     # rubocop:disable Layout/EmptyLines
 
 
+    # Calls {OCI::Core::BlockstorageClient#delete_boot_volume_backup} and then waits for the {OCI::Core::Models::BootVolumeBackup} acted upon
+    # to enter the given state(s).
+    #
+    # @param [String] boot_volume_backup_id The OCID of the boot volume backup.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Core::Models::BootVolumeBackup#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Core::BlockstorageClient#delete_boot_volume_backup}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object with data of type nil
+    def delete_boot_volume_backup_and_wait_for_state(boot_volume_backup_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      initial_get_result = @service_client.get_boot_volume_backup(boot_volume_backup_id)
+      operation_result = @service_client.delete_boot_volume_backup(boot_volume_backup_id, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+
+      begin
+        waiter_result = initial_get_result.wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
+          max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+          max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200,
+          succeed_on_not_found: true
+        )
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
     # Calls {OCI::Core::BlockstorageClient#delete_volume} and then waits for the {OCI::Core::Models::Volume} acted upon
     # to enter the given state(s).
     #
@@ -420,6 +538,46 @@ module OCI
     # rubocop:disable Layout/EmptyLines
 
 
+    # Calls {OCI::Core::BlockstorageClient#update_boot_volume_backup} and then waits for the {OCI::Core::Models::BootVolumeBackup} acted upon
+    # to enter the given state(s).
+    #
+    # @param [String] boot_volume_backup_id The OCID of the boot volume backup.
+    # @param [OCI::Core::Models::UpdateBootVolumeBackupDetails] update_boot_volume_backup_details Update boot volume backup fields
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Core::Models::BootVolumeBackup#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Core::BlockstorageClient#update_boot_volume_backup}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object with data of type {OCI::Core::Models::BootVolumeBackup}
+    def update_boot_volume_backup_and_wait_for_state(boot_volume_backup_id, update_boot_volume_backup_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.update_boot_volume_backup(boot_volume_backup_id, update_boot_volume_backup_details, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+      wait_for_resource_id = operation_result.data.id
+
+      begin
+        waiter_result = @service_client.get_boot_volume_backup(wait_for_resource_id).wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
+          max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+          max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+        )
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
     # Calls {OCI::Core::BlockstorageClient#update_volume} and then waits for the {OCI::Core::Models::Volume} acted upon
     # to enter the given state(s).
     #

data/lib/oci/core/compute_client.rb

@@ -1409,18 +1409,17 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Performs one of the power actions (start, stop, softreset, softstop, or reset)
-    # on the specified instance.
+    # Performs one of the following power actions on the specified instance:
     #
-    # **start** - power on
+    # - **START** - Powers on the instance.
     #
-    # **stop** - power off
+    # - **STOP** - Powers off the instance.
     #
-    # **softreset** - ACPI shutdown and power on
+    # - **SOFTRESET** - Gracefully reboots instance by sending a shutdown command to the operating system and then powers the instance back on.
     #
-    # **softstop** - signal the instance operating system to shutdown gracefully
+    # - **SOFTSTOP** - Gracefully shuts down instance by sending a shutdown command to the operating system.
     #
-    # **reset** - power off and power on
+    # - **RESET** - Powers off the instance and then powers it back on.
     #
     # For more information see [Stopping and Starting an Instance](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/restartinginstance.htm).
     #

data/lib/oci/core/core.rb

@@ -17,6 +17,10 @@ require 'oci/core/models/attach_vnic_details'
 require 'oci/core/models/attach_volume_details'
 require 'oci/core/models/boot_volume'
 require 'oci/core/models/boot_volume_attachment'
+require 'oci/core/models/boot_volume_backup'
+require 'oci/core/models/boot_volume_source_details'
+require 'oci/core/models/boot_volume_source_from_boot_volume_backup_details'
+require 'oci/core/models/boot_volume_source_from_boot_volume_details'
 require 'oci/core/models/bulk_add_virtual_circuit_public_prefixes_details'
 require 'oci/core/models/bulk_delete_virtual_circuit_public_prefixes_details'
 require 'oci/core/models/capture_console_history_details'
@@ -24,6 +28,8 @@ require 'oci/core/models/connect_local_peering_gateways_details'
 require 'oci/core/models/connect_remote_peering_connections_details'
 require 'oci/core/models/console_history'
 require 'oci/core/models/cpe'
+require 'oci/core/models/create_boot_volume_backup_details'
+require 'oci/core/models/create_boot_volume_details'
 require 'oci/core/models/create_cpe_details'
 require 'oci/core/models/create_cross_connect_details'
 require 'oci/core/models/create_cross_connect_group_details'
@@ -40,6 +46,7 @@ require 'oci/core/models/create_public_ip_details'
 require 'oci/core/models/create_remote_peering_connection_details'
 require 'oci/core/models/create_route_table_details'
 require 'oci/core/models/create_security_list_details'
+require 'oci/core/models/create_service_gateway_details'
 require 'oci/core/models/create_subnet_details'
 require 'oci/core/models/create_vcn_details'
 require 'oci/core/models/create_virtual_circuit_details'
@@ -100,12 +107,17 @@ require 'oci/core/models/remote_peering_connection'
 require 'oci/core/models/route_rule'
 require 'oci/core/models/route_table'
 require 'oci/core/models/security_list'
+require 'oci/core/models/service'
+require 'oci/core/models/service_gateway'
+require 'oci/core/models/service_id_request_details'
+require 'oci/core/models/service_id_response_details'
 require 'oci/core/models/shape'
 require 'oci/core/models/subnet'
 require 'oci/core/models/tcp_options'
 require 'oci/core/models/tunnel_config'
 require 'oci/core/models/tunnel_status'
 require 'oci/core/models/udp_options'
+require 'oci/core/models/update_boot_volume_backup_details'
 require 'oci/core/models/update_boot_volume_details'
 require 'oci/core/models/update_console_history_details'
 require 'oci/core/models/update_cpe_details'
@@ -124,6 +136,7 @@ require 'oci/core/models/update_public_ip_details'
 require 'oci/core/models/update_remote_peering_connection_details'
 require 'oci/core/models/update_route_table_details'
 require 'oci/core/models/update_security_list_details'
+require 'oci/core/models/update_service_gateway_details'
 require 'oci/core/models/update_subnet_details'
 require 'oci/core/models/update_vcn_details'
 require 'oci/core/models/update_virtual_circuit_details'

data/lib/oci/core/models/boot_volume.rb

@@ -34,12 +34,29 @@ module OCI
     # @return [String]
     attr_accessor :compartment_id
 
+    # Defined tags for this resource. Each key is predefined and scoped to a namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    #
+    # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+    #
+    # @return [Hash<String, Hash<String, Object>>]
+    attr_accessor :defined_tags
+
     # A user-friendly name. Does not have to be unique, and it's changeable.
     # Avoid entering confidential information.
     #
     # @return [String]
     attr_accessor :display_name
 
+    # Free-form tags for this resource. Each tag is a simple key-value pair with no
+    # predefined name, type, or namespace. For more information, see
+    # [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    #
+    # Example: `{\"Department\": \"Finance\"}`
+    #
+    # @return [Hash<String, String>]
+    attr_accessor :freeform_tags
+
     # **[Required]** The boot volume's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
@@ -48,6 +65,10 @@ module OCI
     # @return [String]
     attr_accessor :image_id
 
+    # Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
+    # @return [BOOLEAN]
+    attr_accessor :is_hydrated
+
     # **[Required]** The current state of a boot volume.
     # @return [String]
     attr_reader :lifecycle_state
@@ -62,6 +83,12 @@ module OCI
     # @return [Integer]
     attr_accessor :size_in_mbs
 
+    # The boot volume source, either an existing boot volume in the same Availability Domain or a boot volume backup.
+    # If null, this means that the boot volume was created from an image.
+    #
+    # @return [OCI::Core::Models::BootVolumeSourceDetails]
+    attr_accessor :source_details
+
     # **[Required]** The date and time the boot volume was created. Format defined by RFC3339.
     # @return [DateTime]
     attr_accessor :time_created
@@ -76,12 +103,16 @@ module OCI
         # rubocop:disable Style/SymbolLiteral
         'availability_domain': :'availabilityDomain',
         'compartment_id': :'compartmentId',
+        'defined_tags': :'definedTags',
         'display_name': :'displayName',
+        'freeform_tags': :'freeformTags',
         'id': :'id',
         'image_id': :'imageId',
+        'is_hydrated': :'isHydrated',
         'lifecycle_state': :'lifecycleState',
         'size_in_gbs': :'sizeInGBs',
         'size_in_mbs': :'sizeInMBs',
+        'source_details': :'sourceDetails',
         'time_created': :'timeCreated',
         'volume_group_id': :'volumeGroupId'
         # rubocop:enable Style/SymbolLiteral
@@ -94,12 +125,16 @@ module OCI
         # rubocop:disable Style/SymbolLiteral
         'availability_domain': :'String',
         'compartment_id': :'String',
+        'defined_tags': :'Hash<String, Hash<String, Object>>',
         'display_name': :'String',
+        'freeform_tags': :'Hash<String, String>',
         'id': :'String',
         'image_id': :'String',
+        'is_hydrated': :'BOOLEAN',
         'lifecycle_state': :'String',
         'size_in_gbs': :'Integer',
         'size_in_mbs': :'Integer',
+        'source_details': :'OCI::Core::Models::BootVolumeSourceDetails',
         'time_created': :'DateTime',
         'volume_group_id': :'String'
         # rubocop:enable Style/SymbolLiteral
@@ -114,12 +149,16 @@ module OCI
     # @param [Hash] attributes Model attributes in the form of hash
     # @option attributes [String] :availability_domain The value to assign to the {#availability_domain} property
     # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
     # @option attributes [String] :display_name The value to assign to the {#display_name} property
+    # @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property
     # @option attributes [String] :id The value to assign to the {#id} property
     # @option attributes [String] :image_id The value to assign to the {#image_id} property
+    # @option attributes [BOOLEAN] :is_hydrated The value to assign to the {#is_hydrated} property
     # @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property
     # @option attributes [Integer] :size_in_gbs The value to assign to the {#size_in_gbs} property
     # @option attributes [Integer] :size_in_mbs The value to assign to the {#size_in_mbs} property
+    # @option attributes [OCI::Core::Models::BootVolumeSourceDetails] :source_details The value to assign to the {#source_details} property
     # @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
     # @option attributes [String] :volume_group_id The value to assign to the {#volume_group_id} property
     def initialize(attributes = {})
@@ -140,12 +179,24 @@ module OCI
 
       self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']
 
+      self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']
+
+      raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')
+
+      self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
+
       self.display_name = attributes[:'displayName'] if attributes[:'displayName']
 
       raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')
 
       self.display_name = attributes[:'display_name'] if attributes[:'display_name']
 
+      self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']
+
+      raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')
+
+      self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']
+
       self.id = attributes[:'id'] if attributes[:'id']
 
       self.image_id = attributes[:'imageId'] if attributes[:'imageId']
@@ -154,6 +205,12 @@ module OCI
 
       self.image_id = attributes[:'image_id'] if attributes[:'image_id']
 
+      self.is_hydrated = attributes[:'isHydrated'] unless attributes[:'isHydrated'].nil?
+
+      raise 'You cannot provide both :isHydrated and :is_hydrated' if attributes.key?(:'isHydrated') && attributes.key?(:'is_hydrated')
+
+      self.is_hydrated = attributes[:'is_hydrated'] unless attributes[:'is_hydrated'].nil?
+
       self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']
 
       raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')
@@ -172,6 +229,12 @@ module OCI
 
       self.size_in_mbs = attributes[:'size_in_mbs'] if attributes[:'size_in_mbs']
 
+      self.source_details = attributes[:'sourceDetails'] if attributes[:'sourceDetails']
+
+      raise 'You cannot provide both :sourceDetails and :source_details' if attributes.key?(:'sourceDetails') && attributes.key?(:'source_details')
+
+      self.source_details = attributes[:'source_details'] if attributes[:'source_details']
+
       self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']
 
       raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')
@@ -212,12 +275,16 @@ module OCI
       self.class == other.class &&
         availability_domain == other.availability_domain &&
         compartment_id == other.compartment_id &&
+        defined_tags == other.defined_tags &&
         display_name == other.display_name &&
+        freeform_tags == other.freeform_tags &&
         id == other.id &&
         image_id == other.image_id &&
+        is_hydrated == other.is_hydrated &&
         lifecycle_state == other.lifecycle_state &&
         size_in_gbs == other.size_in_gbs &&
         size_in_mbs == other.size_in_mbs &&
+        source_details == other.source_details &&
         time_created == other.time_created &&
         volume_group_id == other.volume_group_id
     end
@@ -235,7 +302,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [availability_domain, compartment_id, display_name, id, image_id, lifecycle_state, size_in_gbs, size_in_mbs, time_created, volume_group_id].hash
+      [availability_domain, compartment_id, defined_tags, display_name, freeform_tags, id, image_id, is_hydrated, lifecycle_state, size_in_gbs, size_in_mbs, source_details, time_created, volume_group_id].hash
     end
     # rubocop:enable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
 

data/lib/oci/core/models/boot_volume_backup.rb

@@ -0,0 +1,435 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+require 'logger'
+
+# rubocop:disable Lint/UnneededCopDisableDirective
+module OCI
+  # A point-in-time copy of a boot volume that can then be used to create
+  # a new boot volume or recover a boot volume. For more information, see [Overview
+  # of Boot Volume Backups](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumebackups.htm)
+  # To use any of the API operations, you must be authorized in an IAM policy.
+  # If you're not authorized, talk to an administrator. If you're an administrator
+  # who needs to write policies to give users access, see [Getting Started with
+  # Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
+  class Core::Models::BootVolumeBackup # rubocop:disable Metrics/LineLength
+    LIFECYCLE_STATE_ENUM = [
+      LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
+      LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
+      LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
+      LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
+      LIFECYCLE_STATE_FAULTY = 'FAULTY'.freeze,
+      LIFECYCLE_STATE_REQUEST_RECEIVED = 'REQUEST_RECEIVED'.freeze,
+      LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    SOURCE_TYPE_ENUM = [
+      SOURCE_TYPE_MANUAL = 'MANUAL'.freeze,
+      SOURCE_TYPE_SCHEDULED = 'SCHEDULED'.freeze,
+      SOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    TYPE_ENUM = [
+      TYPE_FULL = 'FULL'.freeze,
+      TYPE_INCREMENTAL = 'INCREMENTAL'.freeze,
+      TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    # The OCID of the boot volume.
+    # @return [String]
+    attr_accessor :boot_volume_id
+
+    # **[Required]** The OCID of the compartment that contains the boot volume backup.
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # Defined tags for this resource. Each key is predefined and scoped to a namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    #
+    # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+    #
+    # @return [Hash<String, Hash<String, Object>>]
+    attr_accessor :defined_tags
+
+    # **[Required]** A user-friendly name for the boot volume backup. Does not have to be unique and it's changeable.
+    # Avoid entering confidential information.
+    #
+    # @return [String]
+    attr_accessor :display_name
+
+    # The date and time the volume backup will expire and be automatically deleted.
+    # Format defined by RFC3339. This parameter will always be present for backups that
+    # were created automatically by a scheduled-backup policy. For manually created backups,
+    # it will be absent, signifying that there is no expiration time and the backup will
+    # last forever until manually deleted.
+    #
+    # @return [DateTime]
+    attr_accessor :expiration_time
+
+    # Free-form tags for this resource. Each tag is a simple key-value pair with no
+    # predefined name, type, or namespace. For more information, see
+    # [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    #
+    # Example: `{\"Department\": \"Finance\"}`
+    #
+    # @return [Hash<String, String>]
+    attr_accessor :freeform_tags
+
+    # **[Required]** The OCID of the boot volume backup.
+    # @return [String]
+    attr_accessor :id
+
+    # The image OCID used to create the boot volume the backup is taken from.
+    # @return [String]
+    attr_accessor :image_id
+
+    # **[Required]** The current state of a boot volume backup.
+    # @return [String]
+    attr_reader :lifecycle_state
+
+    # The size of the boot volume, in GBs.
+    #
+    # @return [Integer]
+    attr_accessor :size_in_gbs
+
+    # Specifies whether the backup was created manually, or via scheduled backup policy.
+    # @return [String]
+    attr_reader :source_type
+
+    # **[Required]** The date and time the boot volume backup was created. This is the time the actual point-in-time image
+    # of the volume data was taken. Format defined by RFC3339.
+    #
+    # @return [DateTime]
+    attr_accessor :time_created
+
+    # The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
+    #
+    # @return [DateTime]
+    attr_accessor :time_request_received
+
+    # The type of a volume backup.
+    # @return [String]
+    attr_reader :type
+
+    # The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space
+    # consumed on the boot volume and whether the backup is full or incremental.
+    #
+    # @return [Integer]
+    attr_accessor :unique_size_in_gbs
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'boot_volume_id': :'bootVolumeId',
+        'compartment_id': :'compartmentId',
+        'defined_tags': :'definedTags',
+        'display_name': :'displayName',
+        'expiration_time': :'expirationTime',
+        'freeform_tags': :'freeformTags',
+        'id': :'id',
+        'image_id': :'imageId',
+        'lifecycle_state': :'lifecycleState',
+        'size_in_gbs': :'sizeInGBs',
+        'source_type': :'sourceType',
+        'time_created': :'timeCreated',
+        'time_request_received': :'timeRequestReceived',
+        'type': :'type',
+        'unique_size_in_gbs': :'uniqueSizeInGBs'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'boot_volume_id': :'String',
+        'compartment_id': :'String',
+        'defined_tags': :'Hash<String, Hash<String, Object>>',
+        'display_name': :'String',
+        'expiration_time': :'DateTime',
+        'freeform_tags': :'Hash<String, String>',
+        'id': :'String',
+        'image_id': :'String',
+        'lifecycle_state': :'String',
+        'size_in_gbs': :'Integer',
+        'source_type': :'String',
+        'time_created': :'DateTime',
+        'time_request_received': :'DateTime',
+        'type': :'String',
+        'unique_size_in_gbs': :'Integer'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :boot_volume_id The value to assign to the {#boot_volume_id} property
+    # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
+    # @option attributes [String] :display_name The value to assign to the {#display_name} property
+    # @option attributes [DateTime] :expiration_time The value to assign to the {#expiration_time} property
+    # @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :image_id The value to assign to the {#image_id} property
+    # @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :size_in_gbs The value to assign to the {#size_in_gbs} property
+    # @option attributes [String] :source_type The value to assign to the {#source_type} property
+    # @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
+    # @option attributes [DateTime] :time_request_received The value to assign to the {#time_request_received} property
+    # @option attributes [String] :type The value to assign to the {#type} property
+    # @option attributes [Integer] :unique_size_in_gbs The value to assign to the {#unique_size_in_gbs} property
+    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 }
+
+      self.boot_volume_id = attributes[:'bootVolumeId'] if attributes[:'bootVolumeId']
+
+      raise 'You cannot provide both :bootVolumeId and :boot_volume_id' if attributes.key?(:'bootVolumeId') && attributes.key?(:'boot_volume_id')
+
+      self.boot_volume_id = attributes[:'boot_volume_id'] if attributes[:'boot_volume_id']
+
+      self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']
+
+      raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')
+
+      self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']
+
+      self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']
+
+      raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')
+
+      self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
+
+      self.display_name = attributes[:'displayName'] if attributes[:'displayName']
+
+      raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')
+
+      self.display_name = attributes[:'display_name'] if attributes[:'display_name']
+
+      self.expiration_time = attributes[:'expirationTime'] if attributes[:'expirationTime']
+
+      raise 'You cannot provide both :expirationTime and :expiration_time' if attributes.key?(:'expirationTime') && attributes.key?(:'expiration_time')
+
+      self.expiration_time = attributes[:'expiration_time'] if attributes[:'expiration_time']
+
+      self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']
+
+      raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')
+
+      self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']
+
+      self.id = attributes[:'id'] if attributes[:'id']
+
+      self.image_id = attributes[:'imageId'] if attributes[:'imageId']
+
+      raise 'You cannot provide both :imageId and :image_id' if attributes.key?(:'imageId') && attributes.key?(:'image_id')
+
+      self.image_id = attributes[:'image_id'] if attributes[:'image_id']
+
+      self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']
+
+      raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')
+
+      self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']
+
+      self.size_in_gbs = attributes[:'sizeInGBs'] if attributes[:'sizeInGBs']
+
+      raise 'You cannot provide both :sizeInGBs and :size_in_gbs' if attributes.key?(:'sizeInGBs') && attributes.key?(:'size_in_gbs')
+
+      self.size_in_gbs = attributes[:'size_in_gbs'] if attributes[:'size_in_gbs']
+
+      self.source_type = attributes[:'sourceType'] if attributes[:'sourceType']
+
+      raise 'You cannot provide both :sourceType and :source_type' if attributes.key?(:'sourceType') && attributes.key?(:'source_type')
+
+      self.source_type = attributes[:'source_type'] if attributes[:'source_type']
+
+      self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']
+
+      raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')
+
+      self.time_created = attributes[:'time_created'] if attributes[:'time_created']
+
+      self.time_request_received = attributes[:'timeRequestReceived'] if attributes[:'timeRequestReceived']
+
+      raise 'You cannot provide both :timeRequestReceived and :time_request_received' if attributes.key?(:'timeRequestReceived') && attributes.key?(:'time_request_received')
+
+      self.time_request_received = attributes[:'time_request_received'] if attributes[:'time_request_received']
+
+      self.type = attributes[:'type'] if attributes[:'type']
+
+      self.unique_size_in_gbs = attributes[:'uniqueSizeInGBs'] if attributes[:'uniqueSizeInGBs']
+
+      raise 'You cannot provide both :uniqueSizeInGBs and :unique_size_in_gbs' if attributes.key?(:'uniqueSizeInGBs') && attributes.key?(:'unique_size_in_gbs')
+
+      self.unique_size_in_gbs = attributes[:'unique_size_in_gbs'] if attributes[:'unique_size_in_gbs']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] lifecycle_state Object to be assigned
+    def lifecycle_state=(lifecycle_state)
+      # rubocop:disable Style/ConditionalAssignment
+      if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
+        # rubocop: disable Metrics/LineLength
+        OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        # rubocop: enable Metrics/LineLength
+        @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
+      else
+        @lifecycle_state = lifecycle_state
+      end
+      # rubocop:enable Style/ConditionalAssignment
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] source_type Object to be assigned
+    def source_type=(source_type)
+      # rubocop:disable Style/ConditionalAssignment
+      if source_type && !SOURCE_TYPE_ENUM.include?(source_type)
+        # rubocop: disable Metrics/LineLength
+        OCI.logger.debug("Unknown value for 'source_type' [" + source_type + "]. Mapping to 'SOURCE_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        # rubocop: enable Metrics/LineLength
+        @source_type = SOURCE_TYPE_UNKNOWN_ENUM_VALUE
+      else
+        @source_type = source_type
+      end
+      # rubocop:enable Style/ConditionalAssignment
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      # rubocop:disable Style/ConditionalAssignment
+      if type && !TYPE_ENUM.include?(type)
+        # rubocop: disable Metrics/LineLength
+        OCI.logger.debug("Unknown value for 'type' [" + type + "]. Mapping to 'TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        # rubocop: enable Metrics/LineLength
+        @type = TYPE_UNKNOWN_ENUM_VALUE
+      else
+        @type = type
+      end
+      # rubocop:enable Style/ConditionalAssignment
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+      self.class == other.class &&
+        boot_volume_id == other.boot_volume_id &&
+        compartment_id == other.compartment_id &&
+        defined_tags == other.defined_tags &&
+        display_name == other.display_name &&
+        expiration_time == other.expiration_time &&
+        freeform_tags == other.freeform_tags &&
+        id == other.id &&
+        image_id == other.image_id &&
+        lifecycle_state == other.lifecycle_state &&
+        size_in_gbs == other.size_in_gbs &&
+        source_type == other.source_type &&
+        time_created == other.time_created &&
+        time_request_received == other.time_request_received &&
+        type == other.type &&
+        unique_size_in_gbs == other.unique_size_in_gbs
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+    # @see the `==` method
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [boot_volume_id, compartment_id, defined_tags, display_name, expiration_time, freeform_tags, id, image_id, lifecycle_state, size_in_gbs, source_type, time_created, time_request_received, type, unique_size_in_gbs].hash
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # 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)
+            public_method("#{key}=").call(
+              attributes[self.class.attribute_map[key]]
+                .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
+            )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          public_method("#{key}=").call(
+            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
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # 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 = public_method(attr).call
+        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
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective