Class: OCI::AiVision::Models::CreateImageJobDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_vision/models/create_image_job_details.rb

Overview

The details of the batch image analysis.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateImageJobDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



75
76
77
78
79
80
81
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
110
111
112
113
114
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 75

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

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

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

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

  self.output_location = attributes[:'outputLocation'] if attributes[:'outputLocation']

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

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

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

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

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

  self.is_zip_output_enabled = attributes[:'isZipOutputEnabled'] unless attributes[:'isZipOutputEnabled'].nil?
  self.is_zip_output_enabled = false if is_zip_output_enabled.nil? && !attributes.key?(:'isZipOutputEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_zip_output_enabled = attributes[:'is_zip_output_enabled'] unless attributes[:'is_zip_output_enabled'].nil?
  self.is_zip_output_enabled = false if is_zip_output_enabled.nil? && !attributes.key?(:'isZipOutputEnabled') && !attributes.key?(:'is_zip_output_enabled') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#compartment_id ⇒ String

The compartment identifier from the requester.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 25

def compartment_id
  @compartment_id
end

#display_name ⇒ String

The image job display name.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 29

def display_name
  @display_name
end

#features ⇒ Array<OCI::AiVision::Models::ImageFeature>

[Required] The list of requested image analysis types.

Returns:



17
18
19
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 17

def features
  @features
end

#input_location ⇒ OCI::AiVision::Models::InputLocation

This attribute is required.

Returns:



13
14
15
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 13

def input_location
  @input_location
end

#is_zip_output_enabled ⇒ BOOLEAN

Whether or not to generate a ZIP file containing the results.

Returns:

  • (BOOLEAN) 


33
34
35
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 33

def is_zip_output_enabled
  @is_zip_output_enabled
end

#output_location ⇒ OCI::AiVision::Models::OutputLocation

This attribute is required.

Returns:



21
22
23
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 21

def output_location
  @output_location
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'input_location': :'inputLocation',
    'features': :'features',
    'output_location': :'outputLocation',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'is_zip_output_enabled': :'isZipOutputEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'input_location': :'OCI::AiVision::Models::InputLocation',
    'features': :'Array<OCI::AiVision::Models::ImageFeature>',
    'output_location': :'OCI::AiVision::Models::OutputLocation',
    'compartment_id': :'String',
    'display_name': :'String',
    'is_zip_output_enabled': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 123

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    input_location == other.input_location &&
    features == other.features &&
    output_location == other.output_location &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    is_zip_output_enabled == other.is_zip_output_enabled
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 158

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


138
139
140
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 147

def hash
  [input_location, features, output_location, compartment_id, display_name, is_zip_output_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 191

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) —

    String presentation of the object



185
186
187
 
# File 'lib/oci/ai_vision/models/create_image_job_details.rb', line 185

def to_s
  to_hash.to_s
end