Class: OCI::Jms::Models::CreateJmsPluginDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms/models/create_jms_plugin_details.rb

Overview

The details for creating a JmsPlugin.

Constant Summary collapse

AGENT_TYPE_ENUM = 
[
  AGENT_TYPE_OMA = 'OMA'.freeze,
  AGENT_TYPE_OCA = 'OCA'.freeze,
  AGENT_TYPE_OCMA = 'OCMA'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateJmsPluginDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :agent_id (String) —

    The value to assign to the #agent_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :agent_type (String) —

    The value to assign to the #agent_type property

  • :fleet_id (String) —

    The value to assign to the #fleet_id property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #freeform_tags property



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
127
128
129
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 88

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

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

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

  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_type = attributes[:'agentType'] if attributes[:'agentType']

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

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

  self.fleet_id = attributes[:'fleetId'] if attributes[:'fleetId']

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

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

  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']

  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']
end

Instance Attribute Details

#agent_id ⇒ String

[Required] The OCID of the Management Agent (OMA), the Oracle Cloud Agent (OCA), or the Oracle Container Management Agent (OCMA) instance where the JMS plugin is deployed.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 21

def agent_id
  @agent_id
end

#agent_type ⇒ String

The agent type.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 29

def agent_type
  @agent_type
end

#compartment_id ⇒ String

[Required] The OMA/OCA/OCMA agent's compartment OCID.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 25

def compartment_id
  @compartment_id
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\"}}. (See {Understanding Free-form Tags}[https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm]).

Returns:

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


40
41
42
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 40

def defined_tags
  @defined_tags
end

#fleet_id ⇒ String

The OCID of the fleet.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 34

def fleet_id
  @fleet_id
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\"}. (See {Managing Tags and Tag Namespaces}[https://docs.cloud.oracle.com/Content/Tagging/Concepts/understandingfreeformtags.htm].)

Returns:

  • (Hash<String, String>) 


46
47
48
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 46

def freeform_tags
  @freeform_tags
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'agent_id': :'agentId',
    'compartment_id': :'compartmentId',
    'agent_type': :'agentType',
    'fleet_id': :'fleetId',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 63

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'agent_id': :'String',
    'compartment_id': :'String',
    'agent_type': :'String',
    'fleet_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, 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



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 146

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

  self.class == other.class &&
    agent_id == other.agent_id &&
    compartment_id == other.compartment_id &&
    agent_type == other.agent_type &&
    fleet_id == other.fleet_id &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 181

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


161
162
163
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 161

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



170
171
172
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 170

def hash
  [agent_id, compartment_id, agent_type, fleet_id, defined_tags, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 214

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



208
209
210
 
# File 'lib/oci/jms/models/create_jms_plugin_details.rb', line 208

def to_s
  to_hash.to_s
end