Class: OCI::CloudGuard::Models::CreateWlpAgentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/create_wlp_agent_details.rb

Overview

On-premise resource agent registration request resource. Example: {\"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\", \"agentVersion\": \"1.0.11\", \"certificateSignedRequest\": \"MIIGwjCCBaqgAwIBAgIVAK8hJCS/5Hu0dEMQ2ud\"}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWlpAgentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :agent_version (String)

    The value to assign to the #agent_version property

  • :certificate_signed_request (String)

    The value to assign to the #certificate_signed_request property

  • :os_info (String)

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 85

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

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

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

  self.agent_version = attributes[:'agentVersion'] if attributes[:'agentVersion']

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

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

  self.certificate_signed_request = attributes[:'certificateSignedRequest'] if attributes[:'certificateSignedRequest']

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

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

  self.os_info = attributes[:'osInfo'] if attributes[:'osInfo']

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

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

  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

#agent_versionString

[Required] The version of the agent making the request

Returns:

  • (String)


21
22
23
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 21

def agent_version
  @agent_version
end

#certificate_signed_requestString

[Required] The certificate signed request containing domain, organization names, organization units, city, state, country, email and public key, among other certificate details, signed by private key

Returns:

  • (String)


25
26
27
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 25

def certificate_signed_request
  @certificate_signed_request
end

#compartment_idString

[Required] Compartment OCID of the host

Returns:

  • (String)


17
18
19
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 17

def compartment_id
  @compartment_id
end

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


43
44
45
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 43

def defined_tags
  @defined_tags
end

#freeform_tagsHash<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\"}

Avoid entering confidential information.

Returns:

  • (Hash<String, String>)


37
38
39
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 37

def freeform_tags
  @freeform_tags
end

#os_infoString

[Required] Concatenated OS name, OS version and agent architecture; for example, ubuntu_22.0_amd64.

Returns:

  • (String)


29
30
31
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 29

def os_info
  @os_info
end

Class Method Details

.attribute_mapObject

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



46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'agent_version': :'agentVersion',
    'certificate_signed_request': :'certificateSignedRequest',
    'os_info': :'osInfo',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'agent_version': :'String',
    'certificate_signed_request': :'String',
    'os_info': :'String',
    '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



135
136
137
138
139
140
141
142
143
144
145
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 135

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    agent_version == other.agent_version &&
    certificate_signed_request == other.certificate_signed_request &&
    os_info == other.os_info &&
    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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 170

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


150
151
152
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 150

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



159
160
161
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 159

def hash
  [compartment_id, agent_version, certificate_signed_request, os_info, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



203
204
205
206
207
208
209
210
211
212
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 203

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



197
198
199
# File 'lib/oci/cloud_guard/models/create_wlp_agent_details.rb', line 197

def to_s
  to_hash.to_s
end