class OCI::ManagementAgent::Models::WorkRequestResource

A resource created or operated on by a work request.

Constants

ACTION_TYPE_ENUM

Attributes

action_type[R]

[Required] The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

@return [String]

entity_type[RW]

[Required] The resource type the work request affects. @return [String]

entity_uri[RW]

The URI path that the user can do a GET on to access the resource metadata @return [String]

identifier[RW]

[Required] The identifier of the resource the work request affects. @return [String]

metadata[RW]

Additional metadata about the resource that has been operated upon by this work request. For WorkRequests operationType WORK_DELIVERY the metadata will contain: workDeliveryStatus indicating the status of the work delivery item &WORKDELIVERYSTATUS, workSubmissionKey the WorkSubmission request id,

and workSubmissionDetails containing any details of result

@return [Object]

time_accepted[RW]

The date and time the request was created, as described in [RFC 3339](tools.ietf.org/rfc/rfc3339), section 14.29.

@return [DateTime]

time_finished[RW]

The date and time the request was finished, as described in [RFC 3339](tools.ietf.org/rfc/rfc3339), section 14.29.

@return [DateTime]

time_started[RW]

The date and time the request was started, as described in [RFC 3339](tools.ietf.org/rfc/rfc3339), section 14.29.

@return [DateTime]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/management_agent/models/work_request_resource.rb, line 67
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_type': :'entityType',
    'action_type': :'actionType',
    'identifier': :'identifier',
    'entity_uri': :'entityUri',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'metadata': :'metadata'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :entity_type The value to assign to the {#entity_type} property @option attributes [String] :action_type The value to assign to the {#action_type} property @option attributes [String] :identifier The value to assign to the {#identifier} property @option attributes [String] :entity_uri The value to assign to the {#entity_uri} 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 @option attributes [Object] :metadata The value to assign to the {#metadata} property

# File lib/oci/management_agent/models/work_request_resource.rb, line 112
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.entity_type = attributes[:'entityType'] if attributes[:'entityType']

  raise 'You cannot provide both :entityType and :entity_type' if attributes.key?(:'entityType') && attributes.key?(:'entity_type')

  self.entity_type = attributes[:'entity_type'] if attributes[:'entity_type']

  self.action_type = attributes[:'actionType'] if attributes[:'actionType']

  raise 'You cannot provide both :actionType and :action_type' if attributes.key?(:'actionType') && attributes.key?(:'action_type')

  self.action_type = attributes[:'action_type'] if attributes[:'action_type']

  self.identifier = attributes[:'identifier'] if attributes[:'identifier']

  self.entity_uri = attributes[:'entityUri'] if attributes[:'entityUri']

  raise 'You cannot provide both :entityUri and :entity_uri' if attributes.key?(:'entityUri') && attributes.key?(:'entity_uri')

  self.entity_uri = attributes[:'entity_uri'] if attributes[:'entity_uri']

  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']

  self.metadata = attributes[:'metadata'] if attributes[:'metadata']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/management_agent/models/work_request_resource.rb, line 83
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_type': :'String',
    'action_type': :'String',
    'identifier': :'String',
    'entity_uri': :'String',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'metadata': :'Object'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/management_agent/models/work_request_resource.rb, line 179
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    entity_type == other.entity_type &&
    action_type == other.action_type &&
    identifier == other.identifier &&
    entity_uri == other.entity_uri &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    metadata == other.metadata
end
action_type=(action_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] action_type Object to be assigned

# File lib/oci/management_agent/models/work_request_resource.rb, line 163
def action_type=(action_type)
  # rubocop:disable Style/ConditionalAssignment
  if action_type && !ACTION_TYPE_ENUM.include?(action_type)
    OCI.logger.debug("Unknown value for 'action_type' [" + action_type + "]. Mapping to 'ACTION_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @action_type = ACTION_TYPE_UNKNOWN_ENUM_VALUE
  else
    @action_type = action_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/management_agent/models/work_request_resource.rb, line 216
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
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/management_agent/models/work_request_resource.rb, line 196
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/management_agent/models/work_request_resource.rb, line 205
def hash
  [entity_type, action_type, identifier, entity_uri, time_accepted, time_started, time_finished, metadata].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/management_agent/models/work_request_resource.rb, line 249
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/management_agent/models/work_request_resource.rb, line 243
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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

# File lib/oci/management_agent/models/work_request_resource.rb, line 266
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