Class: OCI::AiVision::Models::CreateVideoJobDetails

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

Overview

Details about the video analysis.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVideoJobDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 86

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

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
end

Instance Attribute Details

#compartment_id ⇒ String

Compartment identifier from the requester.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


41
42
43
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 41

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Video job display name.

Returns:

  • (String) 


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

def display_name
  @display_name
end

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

[Required] a list of video analysis features.

Returns:



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

def features
  @features
end

#freeform_tags ⇒ Hash<String, String>

A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


35
36
37
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 35

def freeform_tags
  @freeform_tags
end

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

This attribute is required.

Returns:



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

def input_location
  @input_location
end

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

This attribute is required.

Returns:



21
22
23
 
# File 'lib/oci/ai_vision/models/create_video_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.



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 44

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

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'input_location': :'OCI::AiVision::Models::InputLocation',
    'features': :'Array<OCI::AiVision::Models::VideoFeature>',
    'output_location': :'OCI::AiVision::Models::OutputLocation',
    'compartment_id': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 138

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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 174

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


154
155
156
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 163

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 207

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



201
202
203
 
# File 'lib/oci/ai_vision/models/create_video_job_details.rb', line 201

def to_s
  to_hash.to_s
end