Class: OCI::Jms::Models::RequestJfrRecordingsDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms/models/request_jfr_recordings_details.rb

Overview

Details of the request to start JFR recordings. When the targets aren't specified, then all managed instances currently in the Fleet are selected.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestJfrRecordingsDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 92

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

  self.jfc_profile_name = attributes[:'jfcProfileName'] if attributes[:'jfcProfileName']

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

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

  self.jfc_v1 = attributes[:'jfcV1'] if attributes[:'jfcV1']

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

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

  self.jfc_v2 = attributes[:'jfcV2'] if attributes[:'jfcV2']

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

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

  self.recording_duration_in_minutes = attributes[:'recordingDurationInMinutes'] if attributes[:'recordingDurationInMinutes']

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

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

  self.recording_size_in_mb = attributes[:'recordingSizeInMb'] if attributes[:'recordingSizeInMb']

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

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

  self.waiting_period_in_minutes = attributes[:'waitingPeriodInMinutes'] if attributes[:'waitingPeriodInMinutes']

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

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

Instance Attribute Details

#jfc_profile_name ⇒ String

[Required] The profile used for JFR events selection. If the name isn't recognized, the settings from jfcV1 or jfcV2 will be used depending on the JVM version. Both jfcV2 and jfcV1 should be provided to ensure JFR collection on different JVM versions.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 22

def jfc_profile_name
  @jfc_profile_name
end

#jfc_v1 ⇒ String

The BASE64 encoded string of JFR settings XML with schema used by JDK 8.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 26

def jfc_v1
  @jfc_v1
end

#jfc_v2 ⇒ String

The BASE64 encoded string of JFR settings XML with schema used by JDK 9 and after.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 31

def jfc_v2
  @jfc_v2
end

#recording_duration_in_minutes ⇒ Integer

Duration of the JFR recording in minutes.

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 35

def recording_duration_in_minutes
  @recording_duration_in_minutes
end

#recording_size_in_mb ⇒ Integer

The maximum size limit for the JFR file collected.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 39

def recording_size_in_mb
  @recording_size_in_mb
end

#targets ⇒ Array<OCI::Jms::Models::JfrAttachmentTarget>

The attachment targets to start JFR.

Returns:



15
16
17
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 15

def targets
  @targets
end

#waiting_period_in_minutes ⇒ Integer

Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used.

Returns:

  • (Integer) 


47
48
49
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 47

def waiting_period_in_minutes
  @waiting_period_in_minutes
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 50

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'targets': :'targets',
    'jfc_profile_name': :'jfcProfileName',
    'jfc_v1': :'jfcV1',
    'jfc_v2': :'jfcV2',
    'recording_duration_in_minutes': :'recordingDurationInMinutes',
    'recording_size_in_mb': :'recordingSizeInMb',
    'waiting_period_in_minutes': :'waitingPeriodInMinutes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'targets': :'Array<OCI::Jms::Models::JfrAttachmentTarget>',
    'jfc_profile_name': :'String',
    'jfc_v1': :'String',
    'jfc_v2': :'String',
    'recording_duration_in_minutes': :'Integer',
    'recording_size_in_mb': :'Integer',
    'waiting_period_in_minutes': :'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



144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 144

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

  self.class == other.class &&
    targets == other.targets &&
    jfc_profile_name == other.jfc_profile_name &&
    jfc_v1 == other.jfc_v1 &&
    jfc_v2 == other.jfc_v2 &&
    recording_duration_in_minutes == other.recording_duration_in_minutes &&
    recording_size_in_mb == other.recording_size_in_mb &&
    waiting_period_in_minutes == other.waiting_period_in_minutes
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



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/jms/models/request_jfr_recordings_details.rb', line 180

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


160
161
162
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



169
170
171
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 169

def hash
  [targets, jfc_profile_name, jfc_v1, jfc_v2, recording_duration_in_minutes, recording_size_in_mb, waiting_period_in_minutes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 213

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



207
208
209
 
# File 'lib/oci/jms/models/request_jfr_recordings_details.rb', line 207

def to_s
  to_hash.to_s
end