Class: OCI::DataLabelingService::Models::WorkRequestResource

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_labeling_service/models/work_request_resource.rb

Overview

A resource created or operated on by a work request.

Constant Summary collapse

ACTION_TYPE_ENUM = 
[
  ACTION_TYPE_CREATED = 'CREATED'.freeze,
  ACTION_TYPE_UPDATED = 'UPDATED'.freeze,
  ACTION_TYPE_DELETED = 'DELETED'.freeze,
  ACTION_TYPE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  ACTION_TYPE_WRITTEN = 'WRITTEN'.freeze,
  ACTION_TYPE_RELATED = 'RELATED'.freeze,
  ACTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkRequestResource

Initializes the object

Options Hash (attributes):

  • :entity_type (String) —

    The value to assign to the #entity_type property

  • :action_type (String) —

    The value to assign to the #action_type property

  • :identifier (String) —

    The value to assign to the #identifier property

  • :entity_uri (String) —

    The value to assign to the #entity_uri property

  • :metadata (Hash<String, String>) —

    The value to assign to the #metadata property

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 82

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.metadata = attributes[:'metadata'] if attributes[:'metadata']
end

Instance Attribute Details

#action_type ⇒ String

[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.

Returns:



31
32
33
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 31

def action_type
  @action_type
end

#entity_type ⇒ String

[Required] The resource type the work request affects.

Returns:



23
24
25
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 23

def entity_type
  @entity_type
end

#entity_uri ⇒ String

The URI path that the user can do a GET on to access the resource metadata

Returns:



39
40
41
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 39

def entity_uri
  @entity_uri
end

#identifier ⇒ String

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

Returns:



35
36
37
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 35

def identifier
  @identifier
end

#metadata ⇒ Hash<String, String>

Additional information that helps to explain the resource.

Returns:



43
44
45
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 43

def metadata
  @metadata
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_type': :'entityType',
    'action_type': :'actionType',
    'identifier': :'identifier',
    'entity_uri': :'entityUri',
    'metadata': :'metadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_type': :'String',
    'action_type': :'String',
    'identifier': :'String',
    'entity_uri': :'String',
    'metadata': :'Hash<String, String>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • the other object to be compared



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 131

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 &&
    metadata == other.metadata
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 165

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) ⇒ Boolean

See Also:

  • `==` method

Parameters:

  • the other object to be compared

Returns:



145
146
147
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • Hash code



154
155
156
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 154

def hash
  [entity_type, action_type, identifier, entity_uri, metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 198

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 ⇒ String

Returns the string representation of the object

Returns:

  • String presentation of the object



192
193
194
 
# File 'lib/oci/data_labeling_service/models/work_request_resource.rb', line 192

def to_s
  to_hash.to_s
end