Class: OCI::AiVision::Models::StreamJobSummary

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

Overview

Job details for a stream analysis.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StreamJobSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 132

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

  self.stream_source_id = attributes[:'streamSourceId'] if attributes[:'streamSourceId']

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

  self.stream_source_id = attributes[:'stream_source_id'] if attributes[:'stream_source_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.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.features = attributes[:'features'] if attributes[:'features']

  self.stream_output_location = attributes[:'streamOutputLocation'] if attributes[:'streamOutputLocation']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] OCID of compartment

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 24

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


63
64
65
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 63

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Stream job display name.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 28

def display_name
  @display_name
end

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

[Required] List of document analysis features.

Returns:



32
33
34
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 32

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


57
58
59
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 57

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] OCID of the streamJob.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 14

def id
  @id
end

#lifecycle_details ⇒ String

[Required] Additional Details of the state of streamJob

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 43

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Stream job.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 39

def lifecycle_state
  @lifecycle_state
end

#stream_output_location ⇒ OCI::AiVision::Models::StreamOutputLocation

Returns:



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

def stream_output_location
  @stream_output_location
end

#stream_source_id ⇒ String

[Required] OCID of the streamSource

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 19

def stream_source_id
  @stream_source_id
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


69
70
71
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 69

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] When the streamJob was created, as an RFC3339 datetime string.

Returns:

  • (DateTime) 


47
48
49
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 47

def time_created
  @time_created
end

#time_updated ⇒ DateTime

When the streamJob was updated, as an RFC3339 datetime string.

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 51

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'stream_source_id': :'streamSourceId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'features': :'features',
    'stream_output_location': :'streamOutputLocation',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 93

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'stream_source_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'features': :'Array<OCI::AiVision::Models::VideoStreamFeature>',
    'stream_output_location': :'OCI::AiVision::Models::StreamOutputLocation',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 216

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

  self.class == other.class &&
    id == other.id &&
    stream_source_id == other.stream_source_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    features == other.features &&
    stream_output_location == other.stream_output_location &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 258

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


238
239
240
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 238

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



247
248
249
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 247

def hash
  [id, stream_source_id, compartment_id, display_name, features, stream_output_location, lifecycle_state, lifecycle_details, time_created, time_updated, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



291
292
293
294
295
296
297
298
299
300
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 291

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



285
286
287
 
# File 'lib/oci/ai_vision/models/stream_job_summary.rb', line 285

def to_s
  to_hash.to_s
end