Class: OCI::ApmSynthetics::Models::OnPremiseVantagePoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_synthetics/models/on_premise_vantage_point.rb

Overview

The information about an On-premise vantage point.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_ON_PREMISE_DOCKER_VANTAGE_POINT = 'ON_PREMISE_DOCKER_VANTAGE_POINT'.freeze,
  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 = {}) ⇒ OnPremiseVantagePoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :name (String) —

    The value to assign to the #name property

  • :type (String) —

    The value to assign to the #type property

  • :description (String) —

    The value to assign to the #description property

  • :workers_summary (OCI::ApmSynthetics::Models::WorkersSummary) —

    The value to assign to the #workers_summary property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



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
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 119

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

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

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

  self.workers_summary = attributes[:'workersSummary'] if attributes[:'workersSummary']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


65
66
67
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 65

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description about the On-premise vantage point.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 35

def description
  @description
end

#display_name ⇒ String

[Required] Unique permanent name of the On-premise vantage point.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 23

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


59
60
61
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 59

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the On-premise vantage point.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 19

def id
  @id
end

#name ⇒ String

[Required] Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 27

def name
  @name
end

#time_created ⇒ DateTime

The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 46

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

Returns:

  • (DateTime) 


53
54
55
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 53

def time_updated
  @time_updated
end

#type ⇒ String

[Required] Type of On-premise vantage point.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 31

def type
  @type
end

#workers_summary ⇒ OCI::ApmSynthetics::Models::WorkersSummary

This attribute is required.

Returns:



39
40
41
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 39

def workers_summary
  @workers_summary
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 68

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'name': :'name',
    'type': :'type',
    'description': :'description',
    'workers_summary': :'workersSummary',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 86

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'name': :'String',
    'type': :'String',
    'description': :'String',
    'workers_summary': :'OCI::ApmSynthetics::Models::WorkersSummary',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 190

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    name == other.name &&
    type == other.type &&
    description == other.description &&
    workers_summary == other.workers_summary &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 229

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


209
210
211
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 209

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



218
219
220
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 218

def hash
  [id, display_name, name, type, description, workers_summary, time_created, time_updated, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 262

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



256
257
258
 
# File 'lib/oci/apm_synthetics/models/on_premise_vantage_point.rb', line 256

def to_s
  to_hash.to_s
end