Class: OCI::DataScience::Models::JobExecProbeDetails

Inherits:
JobProbeDetails show all
Defined in:
lib/oci/data_science/models/job_exec_probe_details.rb

Overview

Runs a command in the job run to check whether application is healthy or not.

Constant Summary

Constants inherited from JobProbeDetails

OCI::DataScience::Models::JobProbeDetails::JOB_PROBE_CHECK_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from JobProbeDetails

#job_probe_check_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from JobProbeDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ JobExecProbeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :command (Array<String>) —

    The value to assign to the #command property

  • :period_in_seconds (Integer) —

    The value to assign to the #period_in_seconds property

  • :failure_threshold (Integer) —

    The value to assign to the #failure_threshold property

  • :initial_delay_in_seconds (Integer) —

    The value to assign to the #initial_delay_in_seconds property



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 64

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

  attributes['jobProbeCheckType'] = 'EXEC'

  super(attributes)

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

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

  self.period_in_seconds = attributes[:'periodInSeconds'] if attributes[:'periodInSeconds']

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

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

  self.failure_threshold = attributes[:'failureThreshold'] if attributes[:'failureThreshold']

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

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

  self.initial_delay_in_seconds = attributes[:'initialDelayInSeconds'] if attributes[:'initialDelayInSeconds']

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

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

Instance Attribute Details

#command ⇒ Array<String>

[Required] The commands to run in the target job run to perform the startup probe

Returns:

  • (Array<String>) 


14
15
16
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 14

def command
  @command
end

#failure_threshold ⇒ Integer

How many times the job will try before giving up when a probe fails.

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 22

def failure_threshold
  @failure_threshold
end

#initial_delay_in_seconds ⇒ Integer

Number of seconds after the job run has started before a startup probe is initiated.

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 26

def initial_delay_in_seconds
  @initial_delay_in_seconds
end

#period_in_seconds ⇒ Integer

Number of seconds how often the job run should perform a startup probe

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 18

def period_in_seconds
  @period_in_seconds
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'job_probe_check_type': :'jobProbeCheckType',
    'command': :'command',
    'period_in_seconds': :'periodInSeconds',
    'failure_threshold': :'failureThreshold',
    'initial_delay_in_seconds': :'initialDelayInSeconds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'job_probe_check_type': :'String',
    'command': :'Array<String>',
    'period_in_seconds': :'Integer',
    'failure_threshold': :'Integer',
    'initial_delay_in_seconds': :'Integer'
    # 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



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 102

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

  self.class == other.class &&
    job_probe_check_type == other.job_probe_check_type &&
    command == other.command &&
    period_in_seconds == other.period_in_seconds &&
    failure_threshold == other.failure_threshold &&
    initial_delay_in_seconds == other.initial_delay_in_seconds
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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 136

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


116
117
118
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 116

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 125

def hash
  [job_probe_check_type, command, period_in_seconds, failure_threshold, initial_delay_in_seconds].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 169

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



163
164
165
 
# File 'lib/oci/data_science/models/job_exec_probe_details.rb', line 163

def to_s
  to_hash.to_s
end