Class: OCI::DisasterRecovery::Models::RunObjectStoreScriptUserDefinedStep

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

Overview

Run Object Store 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 = {}) ⇒ RunObjectStoreScriptUserDefinedStep

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 86

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

  attributes['stepType'] = 'RUN_OBJECTSTORE_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.object_storage_script_location = attributes[:'objectStorageScriptLocation'] if attributes[:'objectStorageScriptLocation']

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

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

  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

#object_storage_script_location ⇒ OCI::DisasterRecovery::Models::ObjectStorageScriptLocation

This attribute is required.

Returns:



33
34
35
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 33

def object_storage_script_location
  @object_storage_script_location
end

#run_as_user ⇒ String

The user ID on the instance that will be used to execute the script specified in 'scriptCommand'. Example: opc

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 45

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_object_store_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 of the instance where this script or command should be executed.

Example: us-ashburn-1

Returns:

  • (String) 


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

def run_on_instance_region
  @run_on_instance_region
end

#script_command ⇒ String

The entire path and arguments for the script that is stored in object store, or inside a compressed archive in object store. Example: /usr/bin/python3.7 scripts/start_server.py --port 8080 --env \"production\" --max-connections 200 --log-level \"INFO\"

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 39

def script_command
  @script_command
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 48

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

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 62

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'step_type': :'String',
    'run_on_instance_id': :'String',
    'run_on_instance_region': :'String',
    'object_storage_script_location': :'OCI::DisasterRecovery::Models::ObjectStorageScriptLocation',
    '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



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 134

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 &&
    object_storage_script_location == other.object_storage_script_location &&
    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



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

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


149
150
151
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 158

def hash
  [step_type, run_on_instance_id, run_on_instance_region, object_storage_script_location, 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



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 202

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



196
197
198
 
# File 'lib/oci/disaster_recovery/models/run_object_store_script_user_defined_step.rb', line 196

def to_s
  to_hash.to_s
end