Class: OCI::FleetAppsManagement::Models::CreateRunbookDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/create_runbook_details.rb

Overview

The information about new Runbook.

Constant Summary collapse

OS_TYPE_ENUM = 
[
  OS_TYPE_WINDOWS = 'WINDOWS'.freeze,
  OS_TYPE_LINUX = 'LINUX'.freeze,
  OS_TYPE_GENERIC = 'GENERIC'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateRunbookDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :operation (String) —

    The value to assign to the #operation property

  • :os_type (String) —

    The value to assign to the #os_type property

  • :platform (String) —

    The value to assign to the #platform property

  • :is_default (BOOLEAN) —

    The value to assign to the #is_default property

  • :is_sudo_access_needed (BOOLEAN) —

    The value to assign to the #is_sudo_access_needed property

  • :estimated_time (String) —

    The value to assign to the #estimated_time property

  • :runbook_version (OCI::FleetAppsManagement::Models::Version) —

    The value to assign to the #runbook_version property

  • :compartment_id (String) —

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



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 133

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

  self.os_type = attributes[:'osType'] if attributes[:'osType']

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

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

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

  self.is_default = attributes[:'isDefault'] unless attributes[:'isDefault'].nil?
  self.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') # rubocop:disable Style/StringLiterals

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

  self.is_default = attributes[:'is_default'] unless attributes[:'is_default'].nil?
  self.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') && !attributes.key?(:'is_default') # rubocop:disable Style/StringLiterals

  self.is_sudo_access_needed = attributes[:'isSudoAccessNeeded'] unless attributes[:'isSudoAccessNeeded'].nil?
  self.is_sudo_access_needed = false if is_sudo_access_needed.nil? && !attributes.key?(:'isSudoAccessNeeded') # rubocop:disable Style/StringLiterals

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

  self.is_sudo_access_needed = attributes[:'is_sudo_access_needed'] unless attributes[:'is_sudo_access_needed'].nil?
  self.is_sudo_access_needed = false if is_sudo_access_needed.nil? && !attributes.key?(:'isSudoAccessNeeded') && !attributes.key?(:'is_sudo_access_needed') # rubocop:disable Style/StringLiterals

  self.estimated_time = attributes[:'estimatedTime'] if attributes[:'estimatedTime']

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

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

  self.runbook_version = attributes[:'runbookVersion'] if attributes[:'runbookVersion']

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

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

  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.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

#compartment_id ⇒ String

[Required] OCID of the compartment to which the resource belongs to.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 61

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

Returns:

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


73
74
75
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 73

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 29

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: My new resource

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 23

def display_name
  @display_name
end

#estimated_time ⇒ String

Estimated time to successfully complete the runbook execution.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 53

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


67
68
69
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 67

def freeform_tags
  @freeform_tags
end

#is_default ⇒ BOOLEAN

Is the runbook default?

Returns:

  • (BOOLEAN) 


45
46
47
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 45

def is_default
  @is_default
end

#is_sudo_access_needed ⇒ BOOLEAN

Does this runbook need SUDO access to execute?

Returns:

  • (BOOLEAN) 


49
50
51
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 49

def is_sudo_access_needed
  @is_sudo_access_needed
end

#operation ⇒ String

[Required] The lifecycle operation performed by the task.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 33

def operation
  @operation
end

#os_type ⇒ String

The OS type for the runbook.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 37

def os_type
  @os_type
end

#platform ⇒ String

The platform of the runbook.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 41

def platform
  @platform
end

#runbook_version ⇒ OCI::FleetAppsManagement::Models::Version

This attribute is required.

Returns:



57
58
59
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 57

def runbook_version
  @runbook_version
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 76

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'operation': :'operation',
    'os_type': :'osType',
    'platform': :'platform',
    'is_default': :'isDefault',
    'is_sudo_access_needed': :'isSudoAccessNeeded',
    'estimated_time': :'estimatedTime',
    'runbook_version': :'runbookVersion',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 96

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'operation': :'String',
    'os_type': :'String',
    'platform': :'String',
    'is_default': :'BOOLEAN',
    'is_sudo_access_needed': :'BOOLEAN',
    'estimated_time': :'String',
    'runbook_version': :'OCI::FleetAppsManagement::Models::Version',
    'compartment_id': :'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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 219

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    operation == other.operation &&
    os_type == other.os_type &&
    platform == other.platform &&
    is_default == other.is_default &&
    is_sudo_access_needed == other.is_sudo_access_needed &&
    estimated_time == other.estimated_time &&
    runbook_version == other.runbook_version &&
    compartment_id == other.compartment_id &&
    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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 260

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


240
241
242
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 240

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



249
250
251
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 249

def hash
  [display_name, description, operation, os_type, platform, is_default, is_sudo_access_needed, estimated_time, runbook_version, compartment_id, 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



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 293

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



287
288
289
 
# File 'lib/oci/fleet_apps_management/models/create_runbook_details.rb', line 287

def to_s
  to_hash.to_s
end