Class: OCI::ApmSynthetics::Models::Script

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_synthetics/models/script.rb

Overview

The information about the script.

Constant Summary collapse

CONTENT_TYPE_ENUM = 
[
  CONTENT_TYPE_SIDE = 'SIDE'.freeze,
  CONTENT_TYPE_JS = 'JS'.freeze,
  CONTENT_TYPE_PLAYWRIGHT_TS = 'PLAYWRIGHT_TS'.freeze,
  CONTENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Script

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
 
# File 'lib/oci/apm_synthetics/models/script.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.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.content_type = attributes[:'contentType'] if attributes[:'contentType']

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

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

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

  self.time_uploaded = attributes[:'timeUploaded'] if attributes[:'timeUploaded']

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

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

  self.content_size_in_bytes = attributes[:'contentSizeInBytes'] if attributes[:'contentSizeInBytes']

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

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

  self.content_file_name = attributes[:'contentFileName'] if attributes[:'contentFileName']

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

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

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

  self.monitor_status_count_map = attributes[:'monitorStatusCountMap'] if attributes[:'monitorStatusCountMap']

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

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

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

Instance Attribute Details

#content ⇒ String

The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: <ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : <ORAP><ON>param name</ON></ORAP> With parameter name and value : <ORAP><ON>param name</ON><OV>param value</OV></ORAP> Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 42

def content
  @content
end

#content_file_name ⇒ String

File name of the uploaded script content.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 54

def content_file_name
  @content_file_name
end

#content_size_in_bytes ⇒ Integer

Size of the script content.

Returns:

  • (Integer) 


50
51
52
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 50

def content_size_in_bytes
  @content_size_in_bytes
end

#content_type ⇒ String

[Required] Content type of the script.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 31

def content_type
  @content_type
end

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

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

Returns:

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


89
90
91
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 89

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Unique name that can be edited. The name should not contain any confidential information.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 27

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: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


83
84
85
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 23

def id
  @id
end

#monitor_status_count_map ⇒ OCI::ApmSynthetics::Models::MonitorStatusCountMap

This attribute is required.

Returns:



63
64
65
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 63

def monitor_status_count_map
  @monitor_status_count_map
end

#parameters ⇒ Array<OCI::ApmSynthetics::Models::ScriptParameterInfo>

List of script parameters. Example: [{\"scriptParameter\": {\"paramName\": \"userid\", \"paramValue\":\"testuser\", \"isSecret\": false}, \"isOverwritten\": false}]

Returns:



59
60
61
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 59

def parameters
  @parameters
end

#time_created ⇒ DateTime

The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 70

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 77

def time_updated
  @time_updated
end

#time_uploaded ⇒ DateTime

The time the script was uploaded.

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 46

def time_uploaded
  @time_uploaded
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'content_type': :'contentType',
    'content': :'content',
    'time_uploaded': :'timeUploaded',
    'content_size_in_bytes': :'contentSizeInBytes',
    'content_file_name': :'contentFileName',
    'parameters': :'parameters',
    'monitor_status_count_map': :'monitorStatusCountMap',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'content_type': :'String',
    'content': :'String',
    'time_uploaded': :'DateTime',
    'content_size_in_bytes': :'Integer',
    'content_file_name': :'String',
    'parameters': :'Array<OCI::ApmSynthetics::Models::ScriptParameterInfo>',
    'monitor_status_count_map': :'OCI::ApmSynthetics::Models::MonitorStatusCountMap',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 245

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    content_type == other.content_type &&
    content == other.content &&
    time_uploaded == other.time_uploaded &&
    content_size_in_bytes == other.content_size_in_bytes &&
    content_file_name == other.content_file_name &&
    parameters == other.parameters &&
    monitor_status_count_map == other.monitor_status_count_map &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 287

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


267
268
269
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 267

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



276
277
278
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 276

def hash
  [id, display_name, content_type, content, time_uploaded, content_size_in_bytes, content_file_name, parameters, monitor_status_count_map, time_created, time_updated, 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



320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 320

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



314
315
316
 
# File 'lib/oci/apm_synthetics/models/script.rb', line 314

def to_s
  to_hash.to_s
end