Class: OCI::AiVision::Models::StreamJob

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

Overview

Job details for a stream analysis.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StreamJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
208
209
210
211
212
213
214
215
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.rb', line 152

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

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

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

  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

#agent_participant_id ⇒ String

participant id of agent where results need to be sent

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 52

def agent_participant_id
  @agent_participant_id
end

#compartment_id ⇒ String

[Required] OCID of compartment

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 37

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


80
81
82
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 80

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Stream job display name.

Returns:

  • (String) 


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

def display_name
  @display_name
end

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

[Required] a list of document analysis features.

Returns:



45
46
47
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 45

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


74
75
76
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 74

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] OCID of the streamJob.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 27

def id
  @id
end

#lifecycle_details ⇒ String

Additional details about current state of streamJob

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 60

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Stream job.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 56

def lifecycle_state
  @lifecycle_state
end

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

Returns:



48
49
50
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 48

def stream_output_location
  @stream_output_location
end

#stream_source_id ⇒ String

[Required] OCID of the streamSource

Returns:

  • (String) 


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

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


86
87
88
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 86

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 64

def time_created
  @time_created
end

#time_updated ⇒ DateTime

When the stream job was updated, as an RFC3339 datetime string.

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 68

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 89

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',
    'agent_participant_id': :'agentParticipantId',
    '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.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 111

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',
    'agent_participant_id': :'String',
    '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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 255

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 298

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


278
279
280
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 278

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



287
288
289
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 287

def hash
  [id, stream_source_id, compartment_id, display_name, features, stream_output_location, agent_participant_id, 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



331
332
333
334
335
336
337
338
339
340
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 331

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



325
326
327
 
# File 'lib/oci/ai_vision/models/stream_job.rb', line 325

def to_s
  to_hash.to_s
end