oraclebmc 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 009662b6268407501bdf0d132f2513c0f7651dd7
-  data.tar.gz: 4f0dc341bb586910c6a0854f6163b41533a31339
+  metadata.gz: 4a0960b9d34e1a8ad853cdf82beb2fd48a26f970
+  data.tar.gz: 46b801ec78590b2aac47fb8507d9c6ddaae0fb57
 SHA512:
-  metadata.gz: 0cb3067bcd79f71b21d78420677a3c00aa68a44991eecb3227b5158561fd538a9da54d7dc2e1397e948b4ae7547d0d33eec0f6273b4f8179f53daf9d65fced31
-  data.tar.gz: fbd07192987de065b15ac971ad348e44fe43f355dbf908290efbcda0730edd63aee6cff3fb06e0b3f921346ac6cf5a678e84d5fc6d7ab6570826eec7a48d4661
+  metadata.gz: 3a044b43dffe75862979d26e2325ea155b932b952c0230b00cffc207f75ea3f88a85cf64350a32db52045bfcaef25bdfaa9c7c231e6f10c0cdfd2bde8209790f
+  data.tar.gz: 859b43d68c44f6db7a2818ccec36727134dd7d43855b73258f51b74bd1d57e4b0200426057695df5c8f33ac0cd06a610cca2a0cc85abfd96f02426444c98ad00

data/README.md

@@ -1,5 +1,5 @@
 # Oracle Bare Metal Cloud Services Ruby SDK
-**Version 1.2.1**
+**Version 1.2.2**
 
 This topic describes how to install, configure, and use the Oracle Bare Metal Cloud Services Ruby SDK.
 
@@ -77,7 +77,7 @@ You can also [download the SDK](https://docs.us-phoenix-1.oraclecloud.com/tools/
  Install the gem with the following command:
  
 
- `gem install oraclebmc-1.2.1.gem`
+ `gem install oraclebmc-1.2.2.gem`
 
 
 The SDK depends on `libcurl`, which may need to be installed or upgraded on some operating systems to be compatible with Oracle Bare Metal Cloud Services. 
@@ -100,6 +100,9 @@ To use any of the APIs, you must supply a {OracleBMC::Config Config} object. You
 * Required credentials and settings: See [SDK and Tool Configuration](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm) in the User Guide.
 * Optional SDK-specific settings: See the {OracleBMC::Config Config} object for the full list of config options.
 
+## Forward Compatibility
+
+Some response fields are enum-typed. In the future, individual services may return values not covered by existing enums for that field. To address this possibility, every enum-type response field has an additional value named "UNKNOWN_ENUM_VALUE". If a service returns a value that is not recognized by your version of the SDK, then the response field will be set to this value. Please ensure that your code handles the "UNKNOWN_ENUM_VALUE" case if you have conditional logic based on an enum-typed field. 
 
 ## Writing Your First Ruby Program with the SDK
 
@@ -256,3 +259,4 @@ Ways to get in touch:
 * [My Oracle Support](https://support.oracle.com)
 
 
+

data/lib/oraclebmc/core/blockstorage_client.rb

@@ -60,9 +60,9 @@ module OracleBMC
     # 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. 
+    # 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 
+    # [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.

data/lib/oraclebmc/core/compute_client.rb

@@ -96,7 +96,7 @@ module OracleBMC
     end
 
     # Captures the most recent serial console data (up to a megabyte) for the
-    # specified instance. 
+    # specified instance.
     # 
     # The `CaptureConsoleHistory` operation works with the other console history operations
     # as described below.
@@ -516,7 +516,7 @@ module OracleBMC
     # 
     # Note that the **stop** state has no effect on the resources you consume.
     # Billing continues for instances that you stop, and related resources continue
-    # to apply against any relevant quotas. You must terminate an instance 
+    # to apply against any relevant quotas. You must terminate an instance
     # ({#terminate_instance terminate_instance})
     # to remove its resources from billing and quotas.
     # 
@@ -569,7 +569,7 @@ module OracleBMC
     end
 
     # Creates a new instance in the specified compartment and the specified Availability Domain.
-    # For general information about instances, see 
+    # For general information about instances, see
     # [Overview of the Compute Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm).
     # 
     # For information about access control and compartments, see
@@ -587,8 +587,9 @@ module OracleBMC
     # on that resource type, or by viewing the resource in the Console.
     # 
     # When you launch an instance, it is automatically attached to a Virtual
-    # Network Interface Card (VNIC) and given both a public and private IP address.
-    # To get both addresses, use the {#list_vnic_attachments list_vnic_attachments}
+    # Network Interface Card (VNIC). The VNIC has a private IP address from
+    # the subnet's CIDR, and optionally a public IP address.         
+    # To get the addresses, use the {#list_vnic_attachments list_vnic_attachments}
     # operation to get the VNIC ID for the instance, and then call
     # {#get_vnic get_vnic} with the VNIC ID.
     # 
@@ -677,7 +678,7 @@ module OracleBMC
         :return_type => 'Array<OracleBMC::Core::Models::ConsoleHistory>')
     end
 
-    # Lists the available images in the specified compartment. For more 
+    # Lists the available images in the specified compartment. For more
     # information about images, see
     # [Managing Custom Images](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/managingcustomimages.htm).
     # 
@@ -788,7 +789,7 @@ module OracleBMC
         :return_type => 'Array<OracleBMC::Core::Models::Instance>')
     end
 
-    # Lists the shapes that can be used to launch an instance within the specified compartment. You can 
+    # Lists the shapes that can be used to launch an instance within the specified compartment. You can
     # filter the list by compatibility with a specific image.
     # 
     # @param [String] compartment_id The OCID of the compartment.

data/lib/oraclebmc/core/core.rb

@@ -14,6 +14,8 @@ require 'oraclebmc/core/models/capture_console_history_details'
 require 'oraclebmc/core/models/console_history'
 require 'oraclebmc/core/models/cpe'
 require 'oraclebmc/core/models/create_cpe_details'
+require 'oraclebmc/core/models/create_cross_connect_details'
+require 'oraclebmc/core/models/create_cross_connect_group_details'
 require 'oraclebmc/core/models/create_dhcp_details'
 require 'oraclebmc/core/models/create_drg_attachment_details'
 require 'oraclebmc/core/models/create_drg_details'
@@ -24,8 +26,16 @@ require 'oraclebmc/core/models/create_route_table_details'
 require 'oraclebmc/core/models/create_security_list_details'
 require 'oraclebmc/core/models/create_subnet_details'
 require 'oraclebmc/core/models/create_vcn_details'
+require 'oraclebmc/core/models/create_virtual_circuit_details'
+require 'oraclebmc/core/models/create_vnic_details'
 require 'oraclebmc/core/models/create_volume_backup_details'
 require 'oraclebmc/core/models/create_volume_details'
+require 'oraclebmc/core/models/cross_connect'
+require 'oraclebmc/core/models/cross_connect_group'
+require 'oraclebmc/core/models/cross_connect_location'
+require 'oraclebmc/core/models/cross_connect_mapping'
+require 'oraclebmc/core/models/cross_connect_port_speed_shape'
+require 'oraclebmc/core/models/cross_connect_status'
 require 'oraclebmc/core/models/dhcp_dns_option'
 require 'oraclebmc/core/models/dhcp_option'
 require 'oraclebmc/core/models/dhcp_options'
@@ -33,6 +43,7 @@ require 'oraclebmc/core/models/dhcp_search_domain_option'
 require 'oraclebmc/core/models/drg'
 require 'oraclebmc/core/models/drg_attachment'
 require 'oraclebmc/core/models/egress_security_rule'
+require 'oraclebmc/core/models/fast_connect_provider_service'
 require 'oraclebmc/core/models/ip_sec_connection'
 require 'oraclebmc/core/models/ip_sec_connection_device_config'
 require 'oraclebmc/core/models/ip_sec_connection_device_status'
@@ -44,6 +55,7 @@ require 'oraclebmc/core/models/instance'
 require 'oraclebmc/core/models/instance_credentials'
 require 'oraclebmc/core/models/internet_gateway'
 require 'oraclebmc/core/models/launch_instance_details'
+require 'oraclebmc/core/models/letter_of_authority'
 require 'oraclebmc/core/models/port_range'
 require 'oraclebmc/core/models/route_rule'
 require 'oraclebmc/core/models/route_table'
@@ -55,6 +67,8 @@ require 'oraclebmc/core/models/tunnel_config'
 require 'oraclebmc/core/models/tunnel_status'
 require 'oraclebmc/core/models/udp_options'
 require 'oraclebmc/core/models/update_cpe_details'
+require 'oraclebmc/core/models/update_cross_connect_details'
+require 'oraclebmc/core/models/update_cross_connect_group_details'
 require 'oraclebmc/core/models/update_dhcp_details'
 require 'oraclebmc/core/models/update_drg_attachment_details'
 require 'oraclebmc/core/models/update_drg_details'
@@ -66,9 +80,12 @@ require 'oraclebmc/core/models/update_route_table_details'
 require 'oraclebmc/core/models/update_security_list_details'
 require 'oraclebmc/core/models/update_subnet_details'
 require 'oraclebmc/core/models/update_vcn_details'
+require 'oraclebmc/core/models/update_virtual_circuit_details'
 require 'oraclebmc/core/models/update_volume_backup_details'
 require 'oraclebmc/core/models/update_volume_details'
 require 'oraclebmc/core/models/vcn'
+require 'oraclebmc/core/models/virtual_circuit'
+require 'oraclebmc/core/models/virtual_circuit_bandwidth_shape'
 require 'oraclebmc/core/models/vnic'
 require 'oraclebmc/core/models/vnic_attachment'
 require 'oraclebmc/core/models/volume'

data/lib/oraclebmc/core/models/create_cross_connect_details.rb

@@ -0,0 +1,203 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OracleBMC
+  class Core::Models::CreateCrossConnectDetails
+    # The OCID of the compartment to contain the cross-connect.
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # The OCID of the cross-connect group to put this cross-connect in.
+    # @return [String]
+    attr_accessor :cross_connect_group_id
+
+    # A user-friendly name. Does not have to be unique, and it's changeable.
+    # @return [String]
+    attr_accessor :display_name
+
+    # If you already have an existing cross-connect or cross-connect group at this FastConnect
+    # location, and you want this new cross-connect to be on a different router (for the
+    # purposes of redundancy), provide the OCID of that existing cross-connect or
+    # cross-connect group.
+    # 
+    # @return [String]
+    attr_accessor :far_cross_connect_or_cross_connect_group_id
+
+    # The name of the FastConnect location where this cross-connect will be installed.
+    # To get a list of the available locations, see
+    # {#list_cross_connect_locations list_cross_connect_locations}.
+    # 
+    # Example: `CyrusOne, Chandler, AZ`
+    # 
+    # @return [String]
+    attr_accessor :location_name
+
+    # If you already have an existing cross-connect or cross-connect group at this FastConnect
+    # location, and you want this new cross-connect to be on the same router, provide the
+    # OCID of that existing cross-connect or cross-connect group.
+    # 
+    # @return [String]
+    attr_accessor :near_cross_connect_or_cross_connect_group_id
+
+    # The port speed for this cross-connect. To get a list of the available port speeds, see
+    # {#list_crossconnect_port_speed_shapes list_crossconnect_port_speed_shapes}.
+    # 
+    # Example: `10 Gbps`
+    # 
+    # @return [String]
+    attr_accessor :port_speed_shape_name
+
+
+    # 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[:'crossConnectGroupId']
+        self.cross_connect_group_id = attributes[:'crossConnectGroupId']
+      end
+      
+      if attributes[:'displayName']
+        self.display_name = attributes[:'displayName']
+      end
+      
+      if attributes[:'farCrossConnectOrCrossConnectGroupId']
+        self.far_cross_connect_or_cross_connect_group_id = attributes[:'farCrossConnectOrCrossConnectGroupId']
+      end
+      
+      if attributes[:'locationName']
+        self.location_name = attributes[:'locationName']
+      end
+      
+      if attributes[:'nearCrossConnectOrCrossConnectGroupId']
+        self.near_cross_connect_or_cross_connect_group_id = attributes[:'nearCrossConnectOrCrossConnectGroupId']
+      end
+      
+      if attributes[:'portSpeedShapeName']
+        self.port_speed_shape_name = attributes[:'portSpeedShapeName']
+      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 &&
+          cross_connect_group_id == other_object.cross_connect_group_id &&
+          display_name == other_object.display_name &&
+          far_cross_connect_or_cross_connect_group_id == other_object.far_cross_connect_or_cross_connect_group_id &&
+          location_name == other_object.location_name &&
+          near_cross_connect_or_cross_connect_group_id == other_object.near_cross_connect_or_cross_connect_group_id &&
+          port_speed_shape_name == other_object.port_speed_shape_name
+    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, cross_connect_group_id, display_name, far_cross_connect_or_cross_connect_group_id, location_name, near_cross_connect_or_cross_connect_group_id, port_speed_shape_name].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| OracleBMC::Internal::Util.convert_to_type($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", OracleBMC::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',
+        :'cross_connect_group_id' => :'crossConnectGroupId',
+        :'display_name' => :'displayName',
+        :'far_cross_connect_or_cross_connect_group_id' => :'farCrossConnectOrCrossConnectGroupId',
+        :'location_name' => :'locationName',
+        :'near_cross_connect_or_cross_connect_group_id' => :'nearCrossConnectOrCrossConnectGroupId',
+        :'port_speed_shape_name' => :'portSpeedShapeName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'compartment_id' => :'String',
+        :'cross_connect_group_id' => :'String',
+        :'display_name' => :'String',
+        :'far_cross_connect_or_cross_connect_group_id' => :'String',
+        :'location_name' => :'String',
+        :'near_cross_connect_or_cross_connect_group_id' => :'String',
+        :'port_speed_shape_name' => :'String'
+      }
+    end
+  end
+end

data/lib/oraclebmc/core/models/create_cross_connect_group_details.rb

@@ -0,0 +1,132 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OracleBMC
+  class Core::Models::CreateCrossConnectGroupDetails
+    # The OCID of the compartment to contain the cross-connect group.
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # A user-friendly name. Does not have to be unique, and it's changeable.
+    # @return [String]
+    attr_accessor :display_name
+
+
+    # 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[:'displayName']
+        self.display_name = attributes[:'displayName']
+      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 &&
+          display_name == other_object.display_name
+    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, display_name].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| OracleBMC::Internal::Util.convert_to_type($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", OracleBMC::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',
+        :'display_name' => :'displayName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'compartment_id' => :'String',
+        :'display_name' => :'String'
+      }
+    end
+  end
+end