class Phrase::ScreenshotMarkerCreateParameters
Attributes
specify the branch to use
Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project.
Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot
Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (x
-axis and y
-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (w
and h
in pixels).
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 15 def self.attribute_map { :'branch' => :'branch', :'key_id' => :'key_id', :'presentation' => :'presentation' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 104 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 40 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::ScreenshotMarkerCreateParameters` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::ScreenshotMarkerCreateParameters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'branch') self.branch = attributes[:'branch'] end if attributes.key?(:'key_id') self.key_id = attributes[:'key_id'] end if attributes.key?(:'presentation') self.presentation = attributes[:'presentation'] end end
List of attributes with nullable: true
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 33 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 24 def self.openapi_types { :'branch' => :'String', :'key_id' => :'String', :'presentation' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 81 def ==(o) return true if self.equal?(o) self.class == o.class && branch == o.branch && key_id == o.key_id && presentation == o.presentation end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 132 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model Phrase.const_get(type).build_from_hash(value) end end
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/phrase/models/screenshot_marker_create_parameters.rb, line 201 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 111 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(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
@see the `==` method @param [Object] Object to be compared
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 91 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 97 def hash [branch, key_id, presentation].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 68 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 183 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 171 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/phrase/models/screenshot_marker_create_parameters.rb, line 75 def valid? true end