Class: OCI::AiSpeech::Models::CreateTranscriptionJobDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_speech/models/create_transcription_job_details.rb

Overview

The information about new Transcription Job.

Constant Summary collapse

ADDITIONAL_TRANSCRIPTION_FORMATS_ENUM = 
[
  ADDITIONAL_TRANSCRIPTION_FORMATS_SRT = 'SRT'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTranscriptionJobDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 108

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

  self.additional_transcription_formats = attributes[:'additionalTranscriptionFormats'] if attributes[:'additionalTranscriptionFormats']

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

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

  self.model_details = attributes[:'modelDetails'] if attributes[:'modelDetails']

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

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

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

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

#additional_transcription_formats ⇒ Array<String>

Transcription Format. By default JSON format will be considered.

Returns:

  • (Array<String>) 


28
29
30
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 28

def additional_transcription_formats
  @additional_transcription_formats
end

#compartment_id ⇒ String

**[Required]** The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 20

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. Example: `{"bar-key": "value"}`

Returns:

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


54
55
56
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 54

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the job.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 24

def description
  @description
end

#display_name ⇒ String

A user-friendly display name for the job.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 16

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `"value"`

Returns:

  • (Hash<String, String>) 


48
49
50
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 48

def freeform_tags
  @freeform_tags
end

#input_location ⇒ OCI::AiSpeech::Models::InputLocation

This attribute is required.

Returns:



38
39
40
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 38

def input_location
  @input_location
end

#model_details ⇒ OCI::AiSpeech::Models::TranscriptionModelDetails

Returns:



31
32
33
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 31

def model_details
  @model_details
end

#normalization ⇒ OCI::AiSpeech::Models::TranscriptionNormalization

Returns:



34
35
36
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 34

def normalization
  @normalization
end

#output_location ⇒ OCI::AiSpeech::Models::OutputLocation

This attribute is required.

Returns:



42
43
44
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 42

def output_location
  @output_location
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 57

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

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 75

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'additional_transcription_formats': :'Array<String>',
    'model_details': :'OCI::AiSpeech::Models::TranscriptionModelDetails',
    'normalization': :'OCI::AiSpeech::Models::TranscriptionNormalization',
    'input_location': :'OCI::AiSpeech::Models::InputLocation',
    'output_location': :'OCI::AiSpeech::Models::OutputLocation',
    '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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 189

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    additional_transcription_formats == other.additional_transcription_formats &&
    model_details == other.model_details &&
    normalization == other.normalization &&
    input_location == other.input_location &&
    output_location == other.output_location &&
    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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 228

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


208
209
210
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 208

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 217

def hash
  [display_name, compartment_id, description, additional_transcription_formats, model_details, normalization, input_location, output_location, 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



261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 261

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



255
256
257
 
# File 'lib/oci/ai_speech/models/create_transcription_job_details.rb', line 255

def to_s
  to_hash.to_s
end