Class: OCI::Logging::Models::UnifiedAgentKubernetesScrapeTarget

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb

Overview

Monitoring scrape object.

Constant Summary collapse

RESOURCE_TYPE_ENUM = 
[
  RESOURCE_TYPE_PODS = 'PODS'.freeze,
  RESOURCE_TYPE_ENDPOINTS = 'ENDPOINTS'.freeze,
  RESOURCE_TYPE_NODES = 'NODES'.freeze,
  RESOURCE_TYPE_SERVICES = 'SERVICES'.freeze,
  RESOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnifiedAgentKubernetesScrapeTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :resource_type (String) —

    The value to assign to the #resource_type property

  • :k8s_namespace (String) —

    The value to assign to the #k8s_namespace property

  • :service_name (String) —

    The value to assign to the #service_name property

  • :resource_group (String) —

    The value to assign to the #resource_group property



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
95
96
97
98
99
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 70

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

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

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

  self.k8s_namespace = attributes[:'k8sNamespace'] if attributes[:'k8sNamespace']

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

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

  self.service_name = attributes[:'serviceName'] if attributes[:'serviceName']

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

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

  self.resource_group = attributes[:'resourceGroup'] if attributes[:'resourceGroup']

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

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

Instance Attribute Details

#k8s_namespace ⇒ String

[Required] K8s namespace of the resource.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 26

def k8s_namespace
  @k8s_namespace
end

#resource_group ⇒ String

Resource group in OCI monitoring.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 34

def resource_group
  @resource_group
end

#resource_type ⇒ String

[Required] Type of resource to scrape metrics.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 22

def resource_type
  @resource_type
end

#service_name ⇒ String

Name of the service prepended to the endpoints.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 30

def service_name
  @service_name
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_type': :'resourceType',
    'k8s_namespace': :'k8sNamespace',
    'service_name': :'serviceName',
    'resource_group': :'resourceGroup'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_type': :'String',
    'k8s_namespace': :'String',
    'service_name': :'String',
    'resource_group': :'String'
    # 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



121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 121

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

  self.class == other.class &&
    resource_type == other.resource_type &&
    k8s_namespace == other.k8s_namespace &&
    service_name == other.service_name &&
    resource_group == other.resource_group
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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 154

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


134
135
136
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 143

def hash
  [resource_type, k8s_namespace, service_name, resource_group].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 187

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



181
182
183
 
# File 'lib/oci/logging/models/unified_agent_kubernetes_scrape_target.rb', line 181

def to_s
  to_hash.to_s
end