Class: OCI::ManagementAgent::Models::ManagementAgentPlugin

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/management_agent/models/management_agent_plugin.rb

Overview

Summary of the ManagementAgentPlugin.

Constant Summary collapse

SUPPORTED_PLATFORM_TYPES_ENUM = 
[
  SUPPORTED_PLATFORM_TYPES_LINUX = 'LINUX'.freeze,
  SUPPORTED_PLATFORM_TYPES_WINDOWS = 'WINDOWS'.freeze,
  SUPPORTED_PLATFORM_TYPES_SOLARIS = 'SOLARIS'.freeze,
  SUPPORTED_PLATFORM_TYPES_MACOSX = 'MACOSX'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementAgentPlugin

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

  • :name (String) —

    The value to assign to the #name property

  • :version (Integer) —

    The value to assign to the #version property

  • :supported_platform_types (Array<String>) —

    The value to assign to the #supported_platform_types property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :is_console_deployable (BOOLEAN) —

    The value to assign to the #is_console_deployable property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property



107
108
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
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 107

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

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

  self.supported_platform_types = attributes[:'supportedPlatformTypes'] if attributes[:'supportedPlatformTypes']

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

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

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

  self.is_console_deployable = attributes[:'isConsoleDeployable'] unless attributes[:'isConsoleDeployable'].nil?
  self.is_console_deployable = true if is_console_deployable.nil? && !attributes.key?(:'isConsoleDeployable') # rubocop:disable Style/StringLiterals

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

  self.is_console_deployable = attributes[:'is_console_deployable'] unless attributes[:'is_console_deployable'].nil?
  self.is_console_deployable = true if is_console_deployable.nil? && !attributes.key?(:'isConsoleDeployable') && !attributes.key?(:'is_console_deployable') # rubocop:disable Style/StringLiterals

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

Instance Attribute Details

#description ⇒ String

Management Agent Plugin description

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 51

def description
  @description
end

#display_name ⇒ String

Management Agent Plugin Display Name

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 47

def display_name
  @display_name
end

#id ⇒ String

[Required] Management Agent Plugin Id

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 31

def id
  @id
end

#is_console_deployable ⇒ BOOLEAN

A flag to indicate whether a given plugin can be deployed from Agent Console UI or not.

Returns:

  • (BOOLEAN) 


55
56
57
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 55

def is_console_deployable
  @is_console_deployable
end

#lifecycle_state ⇒ String

[Required] The current state of Management Agent Plugin

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] Management Agent Plugin Name

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 35

def name
  @name
end

#supported_platform_types ⇒ Array<String>

Supported Platform Types

Returns:

  • (Array<String>) 


43
44
45
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 43

def supported_platform_types
  @supported_platform_types
end

#version ⇒ Integer

Management Agent Plugin Version

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 39

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'version': :'version',
    'supported_platform_types': :'supportedPlatformTypes',
    'display_name': :'displayName',
    'description': :'description',
    'is_console_deployable': :'isConsoleDeployable',
    'lifecycle_state': :'lifecycleState'
    # 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
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 78

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'version': :'Integer',
    'supported_platform_types': :'Array<String>',
    'display_name': :'String',
    'description': :'String',
    'is_console_deployable': :'BOOLEAN',
    'lifecycle_state': :'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



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 178

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    version == other.version &&
    supported_platform_types == other.supported_platform_types &&
    display_name == other.display_name &&
    description == other.description &&
    is_console_deployable == other.is_console_deployable &&
    lifecycle_state == other.lifecycle_state
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 215

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


195
196
197
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 195

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 204

def hash
  [id, name, version, supported_platform_types, display_name, description, is_console_deployable, lifecycle_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 248

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



242
243
244
 
# File 'lib/oci/management_agent/models/management_agent_plugin.rb', line 242

def to_s
  to_hash.to_s
end