Class: OCI::ApmSynthetics::Models::CreateWorkerDetails

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

Overview

Details of the request body used to create a new worker for an On-premise vantage point.

Constant Summary collapse

WORKER_TYPE_ENUM = 
[
  WORKER_TYPE_DOCKER = 'DOCKER'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_DISABLED = 'DISABLED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWorkerDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :version (String) —

    The value to assign to the #version property

  • :resource_principal_token_public_key (String) —

    The value to assign to the #resource_principal_token_public_key property

  • :configuration_details (Object) —

    The value to assign to the #configuration_details property

  • :worker_type (String) —

    The value to assign to the #worker_type property

  • :status (String) —

    The value to assign to the #status property

  • :priority (Integer) —

    The value to assign to the #priority 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



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
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.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.version = attributes[:'version'] if attributes[:'version']

  self.resource_principal_token_public_key = attributes[:'resourcePrincipalTokenPublicKey'] if attributes[:'resourcePrincipalTokenPublicKey']

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

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

  self.configuration_details = attributes[:'configurationDetails'] if attributes[:'configurationDetails']

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

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

  self.worker_type = attributes[:'workerType'] if attributes[:'workerType']
  self.worker_type = "DOCKER" if worker_type.nil? && !attributes.key?(:'workerType') # rubocop:disable Style/StringLiterals

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

  self.worker_type = attributes[:'worker_type'] if attributes[:'worker_type']
  self.worker_type = "DOCKER" if worker_type.nil? && !attributes.key?(:'workerType') && !attributes.key?(:'worker_type') # rubocop:disable Style/StringLiterals

  self.status = attributes[:'status'] if attributes[:'status']
  self.status = "ENABLED" if status.nil? && !attributes.key?(:'status') # rubocop:disable Style/StringLiterals

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

  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

#configuration_details ⇒ Object

Configuration details of the On-premise VP worker.

Returns:

  • (Object) 


34
35
36
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 34

def configuration_details
  @configuration_details
end

#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>>) 


58
59
60
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 58

def defined_tags
  @defined_tags
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>) 


52
53
54
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 52

def freeform_tags
  @freeform_tags
end

#name ⇒ String

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

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 22

def name
  @name
end

#priority ⇒ Integer

Priority of the On-premise VP worker to schedule monitors.

Returns:

  • (Integer) 


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

def priority
  @priority
end

#resource_principal_token_public_key ⇒ String

[Required] public key for resource Principal Token based validation to be used in further calls.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 30

def resource_principal_token_public_key
  @resource_principal_token_public_key
end

#status ⇒ String

Enables or disables the On-premise VP worker.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 42

def status
  @status
end

#version ⇒ String

[Required] Image version of the On-premise VP worker.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 26

def version
  @version
end

#worker_type ⇒ String

Type of the On-premise VP worker.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 38

def worker_type
  @worker_type
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 61

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'version': :'version',
    'resource_principal_token_public_key': :'resourcePrincipalTokenPublicKey',
    'configuration_details': :'configurationDetails',
    'worker_type': :'workerType',
    'status': :'status',
    'priority': :'priority',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 78

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'version': :'String',
    'resource_principal_token_public_key': :'String',
    'configuration_details': :'Object',
    'worker_type': :'String',
    'status': :'String',
    'priority': :'Integer',
    '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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 180

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

  self.class == other.class &&
    name == other.name &&
    version == other.version &&
    resource_principal_token_public_key == other.resource_principal_token_public_key &&
    configuration_details == other.configuration_details &&
    worker_type == other.worker_type &&
    status == other.status &&
    priority == other.priority &&
    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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 218

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


198
199
200
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 198

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 207

def hash
  [name, version, resource_principal_token_public_key, configuration_details, worker_type, status, priority, 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



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 251

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



245
246
247
 
# File 'lib/oci/apm_synthetics/models/create_worker_details.rb', line 245

def to_s
  to_hash.to_s
end