oci 2.0.0

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

@@ -0,0 +1,307 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OCI
+  class Core::Models::Instance
+
+    LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
+                LIFECYCLE_STATE_RUNNING = 'RUNNING',
+                LIFECYCLE_STATE_STARTING = 'STARTING',
+                LIFECYCLE_STATE_STOPPING = 'STOPPING',
+                LIFECYCLE_STATE_STOPPED = 'STOPPED',
+                LIFECYCLE_STATE_CREATING_IMAGE = 'CREATING_IMAGE',
+                LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
+                LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
+                LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
+
+    # The Availability Domain the instance is running in.
+    # 
+    # Example: `Uocm:PHX-AD-1`
+    # 
+    # @return [String]
+    attr_accessor :availability_domain
+
+    # The OCID of the compartment that contains the instance.
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # A user-friendly name. Does not have to be unique, and it's changeable.
+    # Avoid entering confidential information.
+    # 
+    # Example: `My bare metal instance`
+    # 
+    # @return [String]
+    attr_accessor :display_name
+
+    # Additional metadata key/value pairs that you provide.  They serve a similar purpose and functionality from fields in the 'metadata' object.
+    # 
+    # They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only).
+    # 
+    # If you don't need nested metadata values, it is strongly advised to avoid using this object and use the Metadata object instead.
+    # 
+    # @return [Hash<String, Object>]
+    attr_accessor :extended_metadata
+
+    # The OCID of the instance.
+    # @return [String]
+    attr_accessor :id
+
+    # The image used to boot the instance. You can enumerate all available images by calling
+    # {#list_images list_images}.
+    # 
+    # @return [String]
+    attr_accessor :image_id
+
+    # When an Oracle Bare Metal Cloud Services or virtual machine
+    # instance boots, the iPXE firmware that runs on the instance is
+    # configured to run an iPXE script to continue the boot process.
+    # 
+    # If you want more control over the boot process, you can provide
+    # your own custom iPXE script that will run when the instance boots;
+    # however, you should be aware that the same iPXE script will run
+    # every time an instance boots; not only after the initial
+    # LaunchInstance call.
+    # 
+    # The default iPXE script connects to the instance's local boot
+    # volume over iSCSI and performs a network boot. If you use a custom iPXE
+    # script and want to network-boot from the instance's local boot volume
+    # over iSCSI the same way as the default iPXE script, you should use the
+    # following iSCSI IP address: 169.254.0.2, and boot volume IQN:
+    # iqn.2015-02.oracle.boot.
+    # 
+    # For more information about the Bring Your Own Image feature of
+    # Oracle Bare Metal Cloud Services, see
+    # [Bring Your Own Image](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/bringyourownimage.htm).
+    # 
+    # For more information about iPXE, see http://ipxe.org.
+    # 
+    # @return [String]
+    attr_accessor :ipxe_script
+
+    # The current state of the instance.
+    # @return [String]
+    attr_accessor :lifecycle_state
+
+    # Custom metadata that you provide.
+    # @return [Hash<String, String>]
+    attr_accessor :metadata
+
+    # The region that contains the Availability Domain the instance is running in.
+    # 
+    # Example: `phx`
+    # 
+    # @return [String]
+    attr_accessor :region
+
+    # The shape of the instance. The shape determines the number of CPUs and the amount of memory
+    # allocated to the instance. You can enumerate all available shapes by calling
+    # {#list_shapes list_shapes}.
+    # 
+    # @return [String]
+    attr_accessor :shape
+
+    # The date and time the instance was created, in the format defined by RFC3339.
+    # 
+    # Example: `2016-08-25T21:10:29.600Z`
+    # 
+    # @return [DateTime]
+    attr_accessor :time_created
+
+
+    # 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[:'displayName']
+        self.display_name = attributes[:'displayName']
+      end
+
+      if attributes[:'extendedMetadata']
+        self.extended_metadata = attributes[:'extendedMetadata']
+      end
+
+      if attributes[:'id']
+        self.id = attributes[:'id']
+      end
+
+      if attributes[:'imageId']
+        self.image_id = attributes[:'imageId']
+      end
+
+      if attributes[:'ipxeScript']
+        self.ipxe_script = attributes[:'ipxeScript']
+      end
+
+      if attributes[:'lifecycleState']
+        self.lifecycle_state = attributes[:'lifecycleState']
+      end
+
+      if attributes[:'metadata']
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes[:'region']
+        self.region = attributes[:'region']
+      end
+
+      if attributes[:'shape']
+        self.shape = attributes[:'shape']
+      end
+
+      if attributes[:'timeCreated']
+        self.time_created = attributes[:'timeCreated']
+      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
+
+    # 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 &&
+          display_name == other_object.display_name &&
+          extended_metadata == other_object.extended_metadata &&
+          id == other_object.id &&
+          image_id == other_object.image_id &&
+          ipxe_script == other_object.ipxe_script &&
+          lifecycle_state == other_object.lifecycle_state &&
+          metadata == other_object.metadata &&
+          region == other_object.region &&
+          shape == other_object.shape &&
+          time_created == other_object.time_created
+    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, display_name, extended_metadata, id, image_id, ipxe_script, lifecycle_state, metadata, region, shape, time_created].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 = self.send(attr)
+        next if value.nil?
+        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',
+        :'display_name' => :'displayName',
+        :'extended_metadata' => :'extendedMetadata',
+        :'id' => :'id',
+        :'image_id' => :'imageId',
+        :'ipxe_script' => :'ipxeScript',
+        :'lifecycle_state' => :'lifecycleState',
+        :'metadata' => :'metadata',
+        :'region' => :'region',
+        :'shape' => :'shape',
+        :'time_created' => :'timeCreated'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'availability_domain' => :'String',
+        :'compartment_id' => :'String',
+        :'display_name' => :'String',
+        :'extended_metadata' => :'Hash<String, Object>',
+        :'id' => :'String',
+        :'image_id' => :'String',
+        :'ipxe_script' => :'String',
+        :'lifecycle_state' => :'String',
+        :'metadata' => :'Hash<String, String>',
+        :'region' => :'String',
+        :'shape' => :'String',
+        :'time_created' => :'DateTime'
+      }
+    end
+  end
+end

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

@@ -0,0 +1,193 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OCI
+  class Core::Models::InstanceConsoleConnection
+
+    LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
+                LIFECYCLE_STATE_CREATING = 'CREATING',
+                LIFECYCLE_STATE_DELETED = 'DELETED',
+                LIFECYCLE_STATE_DELETING = 'DELETING',
+                LIFECYCLE_STATE_FAILED = 'FAILED',
+                LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
+
+    # The OCID of the compartment to contain the ConsoleConnection
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # The ssh connection string to the instance console
+    # @return [String]
+    attr_accessor :connection_string
+
+    # The fingerprint of the ssh publicKey.
+    # @return [String]
+    attr_accessor :fingerprint
+
+    # The OCID of the instance console connection
+    # @return [String]
+    attr_accessor :id
+
+    # The host instance OCID
+    # @return [String]
+    attr_accessor :instance_id
+
+    # The current state of the instance console connection.
+    # @return [String]
+    attr_accessor :lifecycle_state
+
+
+    # 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[:'compartmentId']
+        self.compartment_id = attributes[:'compartmentId']
+      end
+
+      if attributes[:'connectionString']
+        self.connection_string = attributes[:'connectionString']
+      end
+
+      if attributes[:'fingerprint']
+        self.fingerprint = attributes[:'fingerprint']
+      end
+
+      if attributes[:'id']
+        self.id = attributes[:'id']
+      end
+
+      if attributes[:'instanceId']
+        self.instance_id = attributes[:'instanceId']
+      end
+
+      if attributes[:'lifecycleState']
+        self.lifecycle_state = attributes[:'lifecycleState']
+      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
+
+    # 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 &&
+          compartment_id == other_object.compartment_id &&
+          connection_string == other_object.connection_string &&
+          fingerprint == other_object.fingerprint &&
+          id == other_object.id &&
+          instance_id == other_object.instance_id &&
+          lifecycle_state == other_object.lifecycle_state
+    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
+      [compartment_id, connection_string, fingerprint, id, instance_id, lifecycle_state].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 = self.send(attr)
+        next if value.nil?
+        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
+      { 
+        :'compartment_id' => :'compartmentId',
+        :'connection_string' => :'connectionString',
+        :'fingerprint' => :'fingerprint',
+        :'id' => :'id',
+        :'instance_id' => :'instanceId',
+        :'lifecycle_state' => :'lifecycleState'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'compartment_id' => :'String',
+        :'connection_string' => :'String',
+        :'fingerprint' => :'String',
+        :'id' => :'String',
+        :'instance_id' => :'String',
+        :'lifecycle_state' => :'String'
+      }
+    end
+  end
+end