Class: OCI::DisasterRecovery::Models::RunLocalScriptUserDefinedStep

Inherits:
DrPlanUserDefinedStep show all
Defined in:
lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb

Overview

Run Local Script step details.

Constant Summary

Constants inherited from DrPlanUserDefinedStep

DrPlanUserDefinedStep::STEP_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DrPlanUserDefinedStep

#step_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DrPlanUserDefinedStep

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ RunLocalScriptUserDefinedStep

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



81
82
83
84
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
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 81

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['stepType'] = 'RUN_LOCAL_SCRIPT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.run_on_instance_id = attributes[:'runOnInstanceId'] if attributes[:'runOnInstanceId']

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

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

  self.run_on_instance_region = attributes[:'runOnInstanceRegion'] if attributes[:'runOnInstanceRegion']

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

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

  self.script_command = attributes[:'scriptCommand'] if attributes[:'scriptCommand']

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

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

  self.run_as_user = attributes[:'runAsUser'] if attributes[:'runAsUser']

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

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

Instance Attribute Details

#run_as_user ⇒ String

The userid on the instance to be used for executing the script or command.

Example: opc

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 43

def run_as_user
  @run_as_user
end

#run_on_instance_id ⇒ String

[Required] The OCID of the instance on which this script or command should be executed.

For moving instances: runOnInstanceId must be the OCID of the instance in the region where the instance is currently present.

For non-moving instances: runOnInstanceId must be the OCID of the non-moving instance.

Example: ocid1.instance.oc1..uniqueID

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 22

def run_on_instance_id
  @run_on_instance_id
end

#run_on_instance_region ⇒ String

[Required] The region in which the instance is present.

Example: us-ashburn-1

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 29

def run_on_instance_region
  @run_on_instance_region
end

#script_command ⇒ String

[Required] The script name and arguments.

Example: /usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 36

def script_command
  @script_command
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'step_type': :'stepType',
    'run_on_instance_id': :'runOnInstanceId',
    'run_on_instance_region': :'runOnInstanceRegion',
    'script_command': :'scriptCommand',
    'run_as_user': :'runAsUser'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'step_type': :'String',
    'run_on_instance_id': :'String',
    'run_on_instance_region': :'String',
    'script_command': :'String',
    'run_as_user': :'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



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 123

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

  self.class == other.class &&
    step_type == other.step_type &&
    run_on_instance_id == other.run_on_instance_id &&
    run_on_instance_region == other.run_on_instance_region &&
    script_command == other.script_command &&
    run_as_user == other.run_as_user
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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 157

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


137
138
139
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 146

def hash
  [step_type, run_on_instance_id, run_on_instance_region, script_command, run_as_user].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 190

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



184
185
186
 
# File 'lib/oci/disaster_recovery/models/run_local_script_user_defined_step.rb', line 184

def to_s
  to_hash.to_s
end