Class: Akeyless::GwUpdateRemoteAccessSessionLogsDatadog

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb

Overview

gwUpdateRemoteAccessSessionLogsDatadog is a command that updates session log forwarding config (datadog target)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GwUpdateRemoteAccessSessionLogsDatadog

Initializes the object

Parameters:

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

    Model attributes in the form of hash



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
164
165
166
167
168
169
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 99

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

  if attributes.key?(:'enable')
    self.enable = attributes[:'enable']
  else
    self.enable = 'true'
  end

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

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

  if attributes.key?(:'log_service')
    self.log_service = attributes[:'log_service']
  else
    self.log_service = 'use-existing'
  end

  if attributes.key?(:'log_source')
    self.log_source = attributes[:'log_source']
  else
    self.log_source = 'use-existing'
  end

  if attributes.key?(:'log_tags')
    self.log_tags = attributes[:'log_tags']
  else
    self.log_tags = 'use-existing'
  end

  if attributes.key?(:'output_format')
    self.output_format = attributes[:'output_format']
  else
    self.output_format = 'text'
  end

  if attributes.key?(:'pull_interval')
    self.pull_interval = attributes[:'pull_interval']
  else
    self.pull_interval = '10'
  end

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

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

Instance Attribute Details

#api_keyObject

Datadog api key



20
21
22
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 20

def api_key
  @api_key
end

#enableObject

Enable Log Forwarding [true/false]



23
24
25
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 23

def enable
  @enable
end

#hostObject

Datadog host



26
27
28
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 26

def host
  @host
end

#jsonObject

Set output format to JSON



29
30
31
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 29

def json
  @json
end

#log_serviceObject

Datadog log service



32
33
34
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 32

def log_service
  @log_service
end

#log_sourceObject

Datadog log source



35
36
37
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 35

def log_source
  @log_source
end

#log_tagsObject

A comma-separated list of Datadog log tags formatted as "key:value" strings



38
39
40
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 38

def log_tags
  @log_tags
end

#output_formatObject

Logs format [text/json]



41
42
43
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 41

def output_format
  @output_format
end

#pull_intervalObject

Pull interval in seconds



44
45
46
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 44

def pull_interval
  @pull_interval
end

#tokenObject

Authentication token (see ‘/auth` and `/configure`)



47
48
49
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 47

def token
  @token
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



50
51
52
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 50

def uid_token
  @uid_token
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 243

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



70
71
72
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 53

def self.attribute_map
  {
    :'api_key' => :'api-key',
    :'enable' => :'enable',
    :'host' => :'host',
    :'json' => :'json',
    :'log_service' => :'log-service',
    :'log_source' => :'log-source',
    :'log_tags' => :'log-tags',
    :'output_format' => :'output-format',
    :'pull_interval' => :'pull-interval',
    :'token' => :'token',
    :'uid_token' => :'uid-token'
  }
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 219

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_nullableObject

List of attributes with nullable: true



92
93
94
95
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 92

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 75

def self.openapi_types
  {
    :'api_key' => :'String',
    :'enable' => :'String',
    :'host' => :'String',
    :'json' => :'Boolean',
    :'log_service' => :'String',
    :'log_source' => :'String',
    :'log_tags' => :'String',
    :'output_format' => :'String',
    :'pull_interval' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_key == o.api_key &&
      enable == o.enable &&
      host == o.host &&
      json == o.json &&
      log_service == o.log_service &&
      log_source == o.log_source &&
      log_tags == o.log_tags &&
      output_format == o.output_format &&
      pull_interval == o.pull_interval &&
      token == o.token &&
      uid_token == o.uid_token
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 314

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 206

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



212
213
214
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 212

def hash
  [api_key, enable, host, json, log_service, log_source, log_tags, output_format, pull_interval, token, uid_token].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



173
174
175
176
177
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 173

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

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



290
291
292
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 290

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 296

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



284
285
286
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 284

def to_s
  to_hash.to_s
end

#valid?Boolean

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

Returns:

  • (Boolean)

    true if the model is valid



181
182
183
184
# File 'lib/akeyless/models/gw_update_remote_access_session_logs_datadog.rb', line 181

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end