Class: Shipeasy::Admin::Generated::TestConnectorResponse

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/shipeasy_admin/models/test_connector_response.rb

Overview

Result of testing a connector. { ok: true, issueUrl } on success; { ok: false, issueUrl: null, error } when the dispatch fails (the request still returns HTTP 200).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ TestConnectorResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 65

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::TestConnectorResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::TestConnectorResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'ok')
    self.ok = attributes[:'ok']
  else
    self.ok = nil
  end

  if attributes.key?(:'issue_url')
    self.issue_url = attributes[:'issue_url']
  else
    self.issue_url = nil
  end

  if attributes.key?(:'error')
    self.error = attributes[:'error']
  end
end

Instance Attribute Details

#error ⇒ Object

Failure reason. Present only when ok is false — the test reached the handler but the underlying dispatch to the provider failed.



26
27
28
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 26

def error
  @error
end

#issue_url ⇒ Object

URL of the artifact the test produced (e.g. the GitHub Issue created by a github connector), or null when the provider produces no linkable artifact (or the dispatch failed).



23
24
25
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 23

def issue_url
  @issue_url
end

#ok ⇒ Object

true when the test dispatch reached the destination; false when the dispatch itself failed (still HTTP 200, with error set).



20
21
22
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 20

def ok
  @ok
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



38
39
40
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 38

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 43

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 29

def self.attribute_map
  {
    :'ok' => :'ok',
    :'issue_url' => :'issueUrl',
    :'error' => :'error'
  }
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 151

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
61
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 57

def self.openapi_nullable
  Set.new([
    :'issue_url',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 48

def self.openapi_types
  {
    :'ok' => :'Boolean',
    :'issue_url' => :'String',
    :'error' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ok == o.ok &&
      issue_url == o.issue_url &&
      error == o.error
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


138
139
140
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



144
145
146
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 144

def hash
  [ok, issue_url, error].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



98
99
100
101
102
103
104
105
106
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 98

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @ok.nil?
    invalid_properties.push('invalid value for "ok", ok cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 173

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



110
111
112
113
114
 
# File 'lib/shipeasy_admin/models/test_connector_response.rb', line 110

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @ok.nil?
  true
end