class OCI::ApmSynthetics::Models::UpdateScriptDetails

Details of the request body used to update a script. Only Side or JavaScript content types are supported and content should be in Side or JavaScript formats only.

Constants

CONTENT_TYPE_ENUM

Attributes

content[RW]

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.

@return [String]

content_file_name[RW]

File name of uploaded script content. @return [String]

content_type[R]

Content type of script. @return [String]

defined_tags[RW]

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

@return [Hash<String, Hash<String, Object>>]

display_name[RW]

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

freeform_tags[RW]

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

@return [Hash<String, String>]

parameters[RW]

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

@return [Array<OCI::ApmSynthetics::Models::ScriptParameter>]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 58
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'content_type': :'contentType',
    'content': :'content',
    'content_file_name': :'contentFileName',
    'parameters': :'parameters',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :content_type The value to assign to the {#content_type} property @option attributes [String] :content The value to assign to the {#content} property @option attributes [String] :content_file_name The value to assign to the {#content_file_name} property @option attributes [Array<OCI::ApmSynthetics::Models::ScriptParameter>] :parameters The value to assign to the {#parameters} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 100
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.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.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.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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 73
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'content_type': :'String',
    'content': :'String',
    'content_file_name': :'String',
    'parameters': :'Array<OCI::ApmSynthetics::Models::ScriptParameter>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 156
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    display_name == other.display_name &&
    content_type == other.content_type &&
    content == other.content &&
    content_file_name == other.content_file_name &&
    parameters == other.parameters &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 192
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
content_type=(content_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] content_type Object to be assigned

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 145
def content_type=(content_type)
  raise "Invalid value for 'content_type': this must be one of the values in CONTENT_TYPE_ENUM." if content_type && !CONTENT_TYPE_ENUM.include?(content_type)

  @content_type = content_type
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 172
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 181
def hash
  [display_name, content_type, content, content_file_name, parameters, freeform_tags, defined_tags].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 225
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 219
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/apm_synthetics/models/update_script_details.rb, line 242
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end