Class: OCI::LogAnalytics::Models::LogEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/log_endpoint.rb

Overview

An endpoint used to fetch logs.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogEndpoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 109

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.name = attributes[:'name'] if attributes[:'name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.model = attributes[:'model'] if attributes[:'model']

  self.endpoint_id = attributes[:'endpointId'] if attributes[:'endpointId']

  raise 'You cannot provide both :endpointId and :endpoint_id' if attributes.key?(:'endpointId') && attributes.key?(:'endpoint_id')

  self.endpoint_id = attributes[:'endpoint_id'] if attributes[:'endpoint_id']

  self.request = attributes[:'request'] if attributes[:'request']

  self.response = attributes[:'response'] if attributes[:'response']

  self.credentials = attributes[:'credentials'] if attributes[:'credentials']

  self.proxy = attributes[:'proxy'] if attributes[:'proxy']

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

  raise 'You cannot provide both :isEnabled and :is_enabled' if attributes.key?(:'isEnabled') && attributes.key?(:'is_enabled')

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?

  self.is_system = attributes[:'isSystem'] unless attributes[:'isSystem'].nil?

  raise 'You cannot provide both :isSystem and :is_system' if attributes.key?(:'isSystem') && attributes.key?(:'is_system')

  self.is_system = attributes[:'is_system'] unless attributes[:'is_system'].nil?

  self.endpoint_properties = attributes[:'endpointProperties'] if attributes[:'endpointProperties']

  raise 'You cannot provide both :endpointProperties and :endpoint_properties' if attributes.key?(:'endpointProperties') && attributes.key?(:'endpoint_properties')

  self.endpoint_properties = attributes[:'endpoint_properties'] if attributes[:'endpoint_properties']
end

Instance Attribute Details

#credentials ⇒ OCI::LogAnalytics::Models::EndpointCredentials

Returns:



35
36
37
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 35

def credentials
  @credentials
end

#description ⇒ String

The endpoint description.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 17

def description
  @description
end

#endpoint_id ⇒ Integer

The endpoint unique identifier.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 25

def endpoint_id
  @endpoint_id
end

#endpoint_properties ⇒ Array<OCI::LogAnalytics::Models::LogAnalyticsProperty>

A list of endpoint properties.

Returns:



52
53
54
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 52

def endpoint_properties
  @endpoint_properties
end

#is_enabled ⇒ BOOLEAN

A flag indicating whether or not the endpoint is enabled for log collection.

Returns:

  • (BOOLEAN) 


42
43
44
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 42

def is_enabled
  @is_enabled
end

#is_system ⇒ BOOLEAN

The system flag. A value of false denotes a custom, or user defined endpoint. A value of true denotes an Oracle defined endpoint.

Returns:

  • (BOOLEAN) 


48
49
50
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 48

def is_system
  @is_system
end

#model ⇒ String

The endpoint model.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 21

def model
  @model
end

#name ⇒ String

[Required] The endpoint name.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 13

def name
  @name
end

#proxy ⇒ OCI::LogAnalytics::Models::EndpointProxy

Returns:



38
39
40
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 38

def proxy
  @proxy
end

#request ⇒ OCI::LogAnalytics::Models::EndpointRequest

This attribute is required.

Returns:



29
30
31
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 29

def request
  @request
end

#response ⇒ OCI::LogAnalytics::Models::EndpointResponse

Returns:



32
33
34
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 32

def response
  @response
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'model': :'model',
    'endpoint_id': :'endpointId',
    'request': :'request',
    'response': :'response',
    'credentials': :'credentials',
    'proxy': :'proxy',
    'is_enabled': :'isEnabled',
    'is_system': :'isSystem',
    'endpoint_properties': :'endpointProperties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 74

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'model': :'String',
    'endpoint_id': :'Integer',
    'request': :'OCI::LogAnalytics::Models::EndpointRequest',
    'response': :'OCI::LogAnalytics::Models::EndpointResponse',
    'credentials': :'OCI::LogAnalytics::Models::EndpointCredentials',
    'proxy': :'OCI::LogAnalytics::Models::EndpointProxy',
    'is_enabled': :'BOOLEAN',
    'is_system': :'BOOLEAN',
    'endpoint_properties': :'Array<OCI::LogAnalytics::Models::LogAnalyticsProperty>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 161

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    model == other.model &&
    endpoint_id == other.endpoint_id &&
    request == other.request &&
    response == other.response &&
    credentials == other.credentials &&
    proxy == other.proxy &&
    is_enabled == other.is_enabled &&
    is_system == other.is_system &&
    endpoint_properties == other.endpoint_properties
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 201

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

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 181

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 190

def hash
  [name, description, model, endpoint_id, request, response, credentials, proxy, is_enabled, is_system, endpoint_properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 234

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



228
229
230
 
# File 'lib/oci/log_analytics/models/log_endpoint.rb', line 228

def to_s
  to_hash.to_s
end