oci 2.0.5 → 2.0.6

data/lib/oci/load_balancer/models/listener_details.rb

@@ -3,19 +3,26 @@
 require 'date'
 
 module OCI
+  # The listener's configuration details.
   class LoadBalancer::Models::ListenerDetails
-    # The name of the associated backend set.
+    # @return [OCI::LoadBalancer::Models::ConnectionConfiguration]
+    attr_accessor :connection_configuration
+
+    # **[Required]** The name of the associated backend set.
+    # 
+    # Example: `My_backend_set`
+    # 
     # @return [String]
     attr_accessor :default_backend_set_name
 
-    # The communication port for the listener.
+    # **[Required]** The communication port for the listener.
     # 
     # Example: `80`
     # 
     # @return [Integer]
     attr_accessor :port
 
-    # The protocol on which the listener accepts connection requests.
+    # **[Required]** The protocol on which the listener accepts connection requests.
     # To get a list of valid protocols, use the {#list_protocols list_protocols}
     # operation.
     # 
@@ -30,12 +37,21 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [OCI::LoadBalancer::Models::ConnectionConfiguration] :connectionConfiguration The value to assign to the {#connection_configuration} property
+    # @option attributes [String] :defaultBackendSetName The value to assign to the {#default_backend_set_name} property
+    # @option attributes [Integer] :port The value to assign to the {#port} property
+    # @option attributes [String] :protocol The value to assign to the {#protocol} property
+    # @option attributes [OCI::LoadBalancer::Models::SSLConfigurationDetails] :sslConfiguration The value to assign to the {#ssl_configuration} 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}
 
+      if attributes[:'connectionConfiguration']
+        self.connection_configuration = attributes[:'connectionConfiguration']
+      end
+
       if attributes[:'defaultBackendSetName']
         self.default_backend_set_name = attributes[:'defaultBackendSetName']
       end
@@ -59,6 +75,7 @@ module OCI
     def ==(other_object)
       return true if self.equal?(other_object)
       self.class == other_object.class &&
+          connection_configuration == other_object.connection_configuration &&
           default_backend_set_name == other_object.default_backend_set_name &&
           port == other_object.port &&
           protocol == other_object.protocol &&
@@ -74,7 +91,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [default_backend_set_name, port, protocol, ssl_configuration].hash
+      [connection_configuration, default_backend_set_name, port, protocol, ssl_configuration].hash
     end
 
     # Builds the object from hash
@@ -140,6 +157,7 @@ module OCI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       { 
+        :'connection_configuration' => :'connectionConfiguration',
         :'default_backend_set_name' => :'defaultBackendSetName',
         :'port' => :'port',
         :'protocol' => :'protocol',
@@ -150,6 +168,7 @@ module OCI
     # Attribute type mapping.
     def self.swagger_types
       { 
+        :'connection_configuration' => :'OCI::LoadBalancer::Models::ConnectionConfiguration',
         :'default_backend_set_name' => :'String',
         :'port' => :'Integer',
         :'protocol' => :'String',

data/lib/oci/load_balancer/models/load_balancer.rb

@@ -3,6 +3,17 @@
 require 'date'
 
 module OCI
+  # The properties that define a load balancer. For more information, see
+  # [Managing a Load Balancer](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingloadbalancer.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).
+  #
+  # For information about endpoints and signing API requests, see
+  # [About the API](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see
+  # [SDKS and Other Tools](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdks.htm).
+  #
   class LoadBalancer::Models::LoadBalancer
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -18,18 +29,18 @@ module OCI
     # @return [Hash<String, OCI::LoadBalancer::Models::Certificate>]
     attr_accessor :certificates
 
-    # The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer.
+    # **[Required]** The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer.
     # @return [String]
     attr_accessor :compartment_id
 
-    # A user-friendly name. It does not have to be unique, and it is changeable.
+    # **[Required]** A user-friendly name. It does not have to be unique, and it is changeable.
     # 
     # Example: `My load balancer`
     # 
     # @return [String]
     attr_accessor :display_name
 
-    # The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer.
+    # **[Required]** The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer.
     # @return [String]
     attr_accessor :id
 
@@ -55,7 +66,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :is_private
 
-    # The current state of the load balancer.
+    # **[Required]** The current state of the load balancer.
     # 
     # @return [String]
     attr_accessor :lifecycle_state
@@ -63,7 +74,7 @@ module OCI
     # @return [Hash<String, OCI::LoadBalancer::Models::Listener>]
     attr_accessor :listeners
 
-    # A template that determines the total pre-provisioned bandwidth (ingress plus egress).
+    # **[Required]** A template that determines the total pre-provisioned bandwidth (ingress plus egress).
     # To get a list of available shapes, use the {#list_shapes list_shapes}
     # operation.
     # 
@@ -76,7 +87,7 @@ module OCI
     # @return [Array<String>]
     attr_accessor :subnet_ids
 
-    # The date and time the load balancer was created, in the format defined by RFC3339.
+    # **[Required]** The date and time the load balancer was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
@@ -86,6 +97,18 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Hash<String, OCI::LoadBalancer::Models::BackendSet>] :backendSets The value to assign to the {#backend_sets} property
+    # @option attributes [Hash<String, OCI::LoadBalancer::Models::Certificate>] :certificates The value to assign to the {#certificates} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [Array<OCI::LoadBalancer::Models::IpAddress>] :ipAddresses The value to assign to the {#ip_addresses} property
+    # @option attributes [BOOLEAN] :isPrivate The value to assign to the {#is_private} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Hash<String, OCI::LoadBalancer::Models::Listener>] :listeners The value to assign to the {#listeners} property
+    # @option attributes [String] :shapeName The value to assign to the {#shape_name} property
+    # @option attributes [Array<String>] :subnetIds The value to assign to the {#subnet_ids} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -116,7 +139,7 @@ module OCI
         self.ip_addresses = attributes[:'ipAddresses']
       end
 
-      if attributes[:'isPrivate']
+      unless attributes[:'isPrivate'].nil?
         self.is_private = attributes[:'isPrivate']
       end
 

data/lib/oci/load_balancer/models/load_balancer_health.rb

@@ -3,6 +3,11 @@
 require 'date'
 
 module OCI
+  # The health status details for the specified load balancer.
+  #
+  # This object does not explicitly enumerate backend sets with a status of `OK`. However, they are included in the
+  # `totalBackendSetCount` sum.
+  #
   class LoadBalancer::Models::LoadBalancerHealth
 
     STATUS_ENUM = [STATUS_OK = 'OK',
@@ -11,7 +16,7 @@ module OCI
                 STATUS_UNKNOWN = 'UNKNOWN',
                 STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the
+    # **[Required]** A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the
     # friendly name you assigned when you created it.
     # 
     # Example: `My_backend_set`
@@ -19,7 +24,7 @@ module OCI
     # @return [Array<String>]
     attr_accessor :critical_state_backend_set_names
 
-    # The overall health status of the load balancer.
+    # **[Required]** The overall health status of the load balancer.
     # 
     # *  **OK:** All backend sets associated with the load balancer return a status of `OK`.
     # 
@@ -42,14 +47,14 @@ module OCI
     # @return [String]
     attr_accessor :status
 
-    # The total number of backend sets associated with this load balancer.
+    # **[Required]** The total number of backend sets associated with this load balancer.
     # 
     # Example: `4`
     # 
     # @return [Integer]
     attr_accessor :total_backend_set_count
 
-    # A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the
+    # **[Required]** A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the
     # friendly name you assigned when you created it.
     # 
     # Example: `Backend_set2`
@@ -57,7 +62,7 @@ module OCI
     # @return [Array<String>]
     attr_accessor :unknown_state_backend_set_names
 
-    # A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the
+    # **[Required]** A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the
     # friendly name you assigned when you created it.
     # 
     # Example: `Backend_set3`
@@ -68,6 +73,11 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<String>] :criticalStateBackendSetNames The value to assign to the {#critical_state_backend_set_names} property
+    # @option attributes [String] :status The value to assign to the {#status} property
+    # @option attributes [Integer] :totalBackendSetCount The value to assign to the {#total_backend_set_count} property
+    # @option attributes [Array<String>] :unknownStateBackendSetNames The value to assign to the {#unknown_state_backend_set_names} property
+    # @option attributes [Array<String>] :warningStateBackendSetNames The value to assign to the {#warning_state_backend_set_names} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/load_balancer_health_summary.rb

@@ -3,6 +3,7 @@
 require 'date'
 
 module OCI
+  # A health status summary for the specified load balancer.
   class LoadBalancer::Models::LoadBalancerHealthSummary
 
     STATUS_ENUM = [STATUS_OK = 'OK',
@@ -11,12 +12,12 @@ module OCI
                 STATUS_UNKNOWN = 'UNKNOWN',
                 STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer the health status is associated with.
+    # **[Required]** The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer the health status is associated with.
     # 
     # @return [String]
     attr_accessor :load_balancer_id
 
-    # The overall health status of the load balancer.
+    # **[Required]** The overall health status of the load balancer.
     # 
     # *  **OK:** All backend sets associated with the load balancer return a status of `OK`.
     # 
@@ -42,6 +43,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :loadBalancerId The value to assign to the {#load_balancer_id} property
+    # @option attributes [String] :status The value to assign to the {#status} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/load_balancer_policy.rb

@@ -3,14 +3,19 @@
 require 'date'
 
 module OCI
+  # A policy that determines how traffic is distributed among backend servers.
+  # For more information on load balancing policies, see
+  # [How Load Balancing Policies Work](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/lbpolicies.htm).
+  #
   class LoadBalancer::Models::LoadBalancerPolicy
-    # The name of the load balancing policy.
+    # **[Required]** The name of the load balancing policy.
     # @return [String]
     attr_accessor :name
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :name The value to assign to the {#name} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/load_balancer_protocol.rb

@@ -3,14 +3,16 @@
 require 'date'
 
 module OCI
+  # The protocol that defines the type of traffic accepted by a listener.
   class LoadBalancer::Models::LoadBalancerProtocol
-    # The name of the protocol.
+    # **[Required]** The name of the protocol.
     # @return [String]
     attr_accessor :name
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :name The value to assign to the {#name} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/load_balancer_shape.rb

@@ -3,14 +3,21 @@
 require 'date'
 
 module OCI
+  # A shape is a template that determines the total pre-provisioned bandwidth (ingress plus egress) for the
+  # load balancer.
+  #
+  # Note that the pre-provisioned maximum capacity applies to aggregated connections, not to a single client
+  # attempting to use the full bandwidth.
+  #
   class LoadBalancer::Models::LoadBalancerShape
-    # The name of the shape.
+    # **[Required]** The name of the shape.
     # @return [String]
     attr_accessor :name
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :name The value to assign to the {#name} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/session_persistence_configuration_details.rb

@@ -3,8 +3,18 @@
 require 'date'
 
 module OCI
+  # The configuration details for implementing session persistence. Session persistence enables the Load Balancing
+  # Service to direct any number of requests that originate from a single logical client to a single backend web server.
+  # For more information, see [Session Persistence](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/sessionpersistence.htm).
+  #
+  # To disable session persistence on a running load balancer, use the
+  # {#update_backend_set update_backend_set} operation and specify \"null\" for the
+  # `SessionPersistenceConfigurationDetails` object.
+  #
+  # Example: `SessionPersistenceConfigurationDetails: null`
+  #
   class LoadBalancer::Models::SessionPersistenceConfigurationDetails
-    # The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify
+    # **[Required]** The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify
     # that any cookie set by the backend causes the session to persist.
     # 
     # Example: `myCookieName`
@@ -23,6 +33,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :cookieName The value to assign to the {#cookie_name} property
+    # @option attributes [BOOLEAN] :disableFallback The value to assign to the {#disable_fallback} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -33,7 +45,7 @@ module OCI
         self.cookie_name = attributes[:'cookieName']
       end
 
-      if attributes[:'disableFallback']
+      unless attributes[:'disableFallback'].nil?
         self.disable_fallback = attributes[:'disableFallback']
       else
         self.disable_fallback = false

data/lib/oci/load_balancer/models/ssl_configuration.rb

@@ -3,8 +3,12 @@
 require 'date'
 
 module OCI
+  # A listener's SSL handling configuration.
+  #
+  # To use SSL, a listener must be associated with a {Certificate}.
+  #
   class LoadBalancer::Models::SSLConfiguration
-    # A friendly name for the certificate bundle. It must be unique and it cannot be changed.
+    # **[Required]** A friendly name for the certificate bundle. It must be unique and it cannot be changed.
     # Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
     # Certificate bundle names cannot contain spaces. Avoid entering confidential information.
     # 
@@ -13,14 +17,14 @@ module OCI
     # @return [String]
     attr_accessor :certificate_name
 
-    # The maximum depth for peer certificate chain verification.
+    # **[Required]** The maximum depth for peer certificate chain verification.
     # 
     # Example: `3`
     # 
     # @return [Integer]
     attr_accessor :verify_depth
 
-    # Whether the load balancer listener should verify peer certificates.
+    # **[Required]** Whether the load balancer listener should verify peer certificates.
     # 
     # Example: `true`
     # 
@@ -30,6 +34,9 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :certificateName The value to assign to the {#certificate_name} property
+    # @option attributes [Integer] :verifyDepth The value to assign to the {#verify_depth} property
+    # @option attributes [BOOLEAN] :verifyPeerCertificate The value to assign to the {#verify_peer_certificate} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -44,7 +51,7 @@ module OCI
         self.verify_depth = attributes[:'verifyDepth']
       end
 
-      if attributes[:'verifyPeerCertificate']
+      unless attributes[:'verifyPeerCertificate'].nil?
         self.verify_peer_certificate = attributes[:'verifyPeerCertificate']
       else
         self.verify_peer_certificate = false

data/lib/oci/load_balancer/models/ssl_configuration_details.rb

@@ -3,8 +3,9 @@
 require 'date'
 
 module OCI
+  # The load balancer's SSL handling configuration details.
   class LoadBalancer::Models::SSLConfigurationDetails
-    # A friendly name for the certificate bundle. It must be unique and it cannot be changed.
+    # **[Required]** A friendly name for the certificate bundle. It must be unique and it cannot be changed.
     # Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
     # Certificate bundle names cannot contain spaces. Avoid entering confidential information.
     # 
@@ -30,6 +31,9 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :certificateName The value to assign to the {#certificate_name} property
+    # @option attributes [Integer] :verifyDepth The value to assign to the {#verify_depth} property
+    # @option attributes [BOOLEAN] :verifyPeerCertificate The value to assign to the {#verify_peer_certificate} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -44,7 +48,7 @@ module OCI
         self.verify_depth = attributes[:'verifyDepth']
       end
 
-      if attributes[:'verifyPeerCertificate']
+      unless attributes[:'verifyPeerCertificate'].nil?
         self.verify_peer_certificate = attributes[:'verifyPeerCertificate']
       else
         self.verify_peer_certificate = false