oci 2.6.0 → 2.7.0

data/lib/oci/oce/models/work_request.rb

@@ -0,0 +1,319 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+require 'logger'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # A description of workrequest status
+  class Oce::Models::WorkRequest
+    OPERATION_TYPE_ENUM = [
+      OPERATION_TYPE_CREATE_OCE_INSTANCE = 'CREATE_OCE_INSTANCE'.freeze,
+      OPERATION_TYPE_UPDATE_OCE_INSTANCE = 'UPDATE_OCE_INSTANCE'.freeze,
+      OPERATION_TYPE_DELETE_OCE_INSTANCE = 'DELETE_OCE_INSTANCE'.freeze,
+      OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    STATUS_ENUM = [
+      STATUS_ACCEPTED = 'ACCEPTED'.freeze,
+      STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
+      STATUS_FAILED = 'FAILED'.freeze,
+      STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
+      STATUS_CANCELING = 'CANCELING'.freeze,
+      STATUS_CANCELED = 'CANCELED'.freeze,
+      STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    # **[Required]** type of the work request
+    # @return [String]
+    attr_reader :operation_type
+
+    # **[Required]** status of current work request.
+    # @return [String]
+    attr_reader :status
+
+    # **[Required]** The id of the work request.
+    # @return [String]
+    attr_accessor :id
+
+    # **[Required]** The ocid of the compartment that contains the work request. Work requests should be scoped to
+    # the same compartment as the resource the work request affects. If the work request affects multiple resources,
+    # and those resources are not in the same compartment, it is up to the service team to pick the primary
+    # resource whose compartment should be used
+    #
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # **[Required]** The resources affected by this work request.
+    # @return [Array<OCI::Oce::Models::WorkRequestResource>]
+    attr_accessor :resources
+
+    # @return [OCI::Oce::Models::WorkflowMonitor]
+    attr_accessor :workflow_monitor
+
+    # **[Required]** Percentage of the request completed.
+    # @return [Float]
+    attr_accessor :percent_complete
+
+    # **[Required]** The date and time the request was created, as described in
+    # [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
+    #
+    # @return [DateTime]
+    attr_accessor :time_accepted
+
+    # The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),
+    # section 14.29.
+    #
+    # @return [DateTime]
+    attr_accessor :time_started
+
+    # The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
+    #
+    # @return [DateTime]
+    attr_accessor :time_finished
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'operation_type': :'operationType',
+        'status': :'status',
+        'id': :'id',
+        'compartment_id': :'compartmentId',
+        'resources': :'resources',
+        'workflow_monitor': :'workflowMonitor',
+        'percent_complete': :'percentComplete',
+        'time_accepted': :'timeAccepted',
+        'time_started': :'timeStarted',
+        'time_finished': :'timeFinished'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'operation_type': :'String',
+        'status': :'String',
+        'id': :'String',
+        'compartment_id': :'String',
+        'resources': :'Array<OCI::Oce::Models::WorkRequestResource>',
+        'workflow_monitor': :'OCI::Oce::Models::WorkflowMonitor',
+        'percent_complete': :'Float',
+        'time_accepted': :'DateTime',
+        'time_started': :'DateTime',
+        'time_finished': :'DateTime'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :operation_type The value to assign to the {#operation_type} property
+    # @option attributes [String] :status The value to assign to the {#status} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
+    # @option attributes [Array<OCI::Oce::Models::WorkRequestResource>] :resources The value to assign to the {#resources} property
+    # @option attributes [OCI::Oce::Models::WorkflowMonitor] :workflow_monitor The value to assign to the {#workflow_monitor} property
+    # @option attributes [Float] :percent_complete The value to assign to the {#percent_complete} property
+    # @option attributes [DateTime] :time_accepted The value to assign to the {#time_accepted} property
+    # @option attributes [DateTime] :time_started The value to assign to the {#time_started} property
+    # @option attributes [DateTime] :time_finished The value to assign to the {#time_finished} 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.operation_type = attributes[:'operationType'] if attributes[:'operationType']
+
+      raise 'You cannot provide both :operationType and :operation_type' if attributes.key?(:'operationType') && attributes.key?(:'operation_type')
+
+      self.operation_type = attributes[:'operation_type'] if attributes[:'operation_type']
+
+      self.status = attributes[:'status'] if attributes[:'status']
+
+      self.id = attributes[:'id'] if attributes[:'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.resources = attributes[:'resources'] if attributes[:'resources']
+
+      self.workflow_monitor = attributes[:'workflowMonitor'] if attributes[:'workflowMonitor']
+
+      raise 'You cannot provide both :workflowMonitor and :workflow_monitor' if attributes.key?(:'workflowMonitor') && attributes.key?(:'workflow_monitor')
+
+      self.workflow_monitor = attributes[:'workflow_monitor'] if attributes[:'workflow_monitor']
+
+      self.percent_complete = attributes[:'percentComplete'] if attributes[:'percentComplete']
+
+      raise 'You cannot provide both :percentComplete and :percent_complete' if attributes.key?(:'percentComplete') && attributes.key?(:'percent_complete')
+
+      self.percent_complete = attributes[:'percent_complete'] if attributes[:'percent_complete']
+
+      self.time_accepted = attributes[:'timeAccepted'] if attributes[:'timeAccepted']
+
+      raise 'You cannot provide both :timeAccepted and :time_accepted' if attributes.key?(:'timeAccepted') && attributes.key?(:'time_accepted')
+
+      self.time_accepted = attributes[:'time_accepted'] if attributes[:'time_accepted']
+
+      self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']
+
+      raise 'You cannot provide both :timeStarted and :time_started' if attributes.key?(:'timeStarted') && attributes.key?(:'time_started')
+
+      self.time_started = attributes[:'time_started'] if attributes[:'time_started']
+
+      self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']
+
+      raise 'You cannot provide both :timeFinished and :time_finished' if attributes.key?(:'timeFinished') && attributes.key?(:'time_finished')
+
+      self.time_finished = attributes[:'time_finished'] if attributes[:'time_finished']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] operation_type Object to be assigned
+    def operation_type=(operation_type)
+      # rubocop:disable Style/ConditionalAssignment
+      if operation_type && !OPERATION_TYPE_ENUM.include?(operation_type)
+        OCI.logger.debug("Unknown value for 'operation_type' [" + operation_type + "]. Mapping to 'OPERATION_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        @operation_type = OPERATION_TYPE_UNKNOWN_ENUM_VALUE
+      else
+        @operation_type = operation_type
+      end
+      # rubocop:enable Style/ConditionalAssignment
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      # rubocop:disable Style/ConditionalAssignment
+      if status && !STATUS_ENUM.include?(status)
+        OCI.logger.debug("Unknown value for 'status' [" + status + "]. Mapping to 'STATUS_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        @status = STATUS_UNKNOWN_ENUM_VALUE
+      else
+        @status = status
+      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 &&
+        operation_type == other.operation_type &&
+        status == other.status &&
+        id == other.id &&
+        compartment_id == other.compartment_id &&
+        resources == other.resources &&
+        workflow_monitor == other.workflow_monitor &&
+        percent_complete == other.percent_complete &&
+        time_accepted == other.time_accepted &&
+        time_started == other.time_started &&
+        time_finished == other.time_finished
+    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, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [operation_type, status, id, compartment_id, resources, workflow_monitor, percent_complete, time_accepted, time_started, time_finished].hash
+    end
+    # rubocop:enable Metrics/AbcSize, 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, Metrics/LineLength

data/lib/oci/oce/models/work_request_error.rb

@@ -0,0 +1,172 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+require 'logger'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # An error encountered while executing a work request.
+  class Oce::Models::WorkRequestError
+    # **[Required]** A machine-usable code for the error that occured. Error codes are listed on
+    # (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
+    #
+    # @return [String]
+    attr_accessor :code
+
+    # **[Required]** A human readable description of the issue encountered.
+    # @return [String]
+    attr_accessor :message
+
+    # **[Required]** The time the error occured. An RFC3339 formatted datetime string.
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'code': :'code',
+        'message': :'message',
+        'timestamp': :'timestamp'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'code': :'String',
+        'message': :'String',
+        'timestamp': :'DateTime'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :code The value to assign to the {#code} property
+    # @option attributes [String] :message The value to assign to the {#message} property
+    # @option attributes [DateTime] :timestamp The value to assign to the {#timestamp} 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.code = attributes[:'code'] if attributes[:'code']
+
+      self.message = attributes[:'message'] if attributes[:'message']
+
+      self.timestamp = attributes[:'timestamp'] if attributes[:'timestamp']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # 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 &&
+        code == other.code &&
+        message == other.message &&
+        timestamp == other.timestamp
+    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, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [code, message, timestamp].hash
+    end
+    # rubocop:enable Metrics/AbcSize, 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, Metrics/LineLength