Class: OryClient::EventStream

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/event_stream.rb

Overview

Event Stream

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ EventStream

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/ory-client/models/event_stream.rb', line 114

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::EventStream` 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 `OryClient::EventStream`. 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?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



19
20
21
 
# File 'lib/ory-client/models/event_stream.rb', line 19

def created_at
  @created_at
end

#http_protocol_major_version ⇒ Object

The major version of the HTTP protocol the endpoint negotiated during the most recent successful connectivity test: 1 for HTTP/1.x, 2 for HTTP/2. Null when the endpoint has not been verified, for example on a paused stream or a non-HTTPS stream.



22
23
24
 
# File 'lib/ory-client/models/event_stream.rb', line 22

def http_protocol_major_version
  @http_protocol_major_version
end

#https_endpoint ⇒ Object

The HTTPS endpoint, if type is HTTPS. Returned with its userinfo and query values masked. Omit it on write to keep the stored endpoint; sending the masked form back overwrites it.



25
26
27
 
# File 'lib/ory-client/models/event_stream.rb', line 25

def https_endpoint
  @https_endpoint
end

#id ⇒ Object

Returns the value of attribute id.



27
28
29
 
# File 'lib/ory-client/models/event_stream.rb', line 27

def id
  @id
end

#role_arn ⇒ Object

The AWS IAM role ARN assumed when publishing to the SNS topic, if type is SNS.



30
31
32
 
# File 'lib/ory-client/models/event_stream.rb', line 30

def role_arn
  @role_arn
end

#status ⇒ Object

The status of the event stream. A paused event stream does not forward any events until it is set back to active.



33
34
35
 
# File 'lib/ory-client/models/event_stream.rb', line 33

def status
  @status
end

#topic_arn ⇒ Object

The AWS SNS topic ARN, if type is SNS.



36
37
38
 
# File 'lib/ory-client/models/event_stream.rb', line 36

def topic_arn
  @topic_arn
end

#type ⇒ Object

Returns the value of attribute type.



38
39
40
 
# File 'lib/ory-client/models/event_stream.rb', line 38

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



40
41
42
 
# File 'lib/ory-client/models/event_stream.rb', line 40

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



80
81
82
 
# File 'lib/ory-client/models/event_stream.rb', line 80

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/ory-client/models/event_stream.rb', line 85

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ory-client/models/event_stream.rb', line 65

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'http_protocol_major_version' => :'http_protocol_major_version',
    :'https_endpoint' => :'https_endpoint',
    :'id' => :'id',
    :'role_arn' => :'role_arn',
    :'status' => :'status',
    :'topic_arn' => :'topic_arn',
    :'type' => :'type',
    :'updated_at' => :'updated_at'
  }
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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ory-client/models/event_stream.rb', line 223

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



105
106
107
108
109
110
 
# File 'lib/ory-client/models/event_stream.rb', line 105

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/ory-client/models/event_stream.rb', line 90

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'http_protocol_major_version' => :'Integer',
    :'https_endpoint' => :'String',
    :'id' => :'String',
    :'role_arn' => :'String',
    :'status' => :'String',
    :'topic_arn' => :'String',
    :'type' => :'String',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/ory-client/models/event_stream.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      http_protocol_major_version == o.http_protocol_major_version &&
      https_endpoint == o.https_endpoint &&
      id == o.id &&
      role_arn == o.role_arn &&
      status == o.status &&
      topic_arn == o.topic_arn &&
      type == o.type &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


210
211
212
 
# File 'lib/ory-client/models/event_stream.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



216
217
218
 
# File 'lib/ory-client/models/event_stream.rb', line 216

def hash
  [created_at, http_protocol_major_version, https_endpoint, id, role_arn, status, topic_arn, type, updated_at].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



167
168
169
170
171
 
# File 'lib/ory-client/models/event_stream.rb', line 167

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/ory-client/models/event_stream.rb', line 245

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



175
176
177
178
179
180
 
# File 'lib/ory-client/models/event_stream.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["active", "paused"])
  return false unless status_validator.valid?(@status)
  true
end