Class: OCI::Jms::Models::ExportSetting

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

Overview

An export settings for JMS fleets.

Constant Summary collapse

EXPORT_DURATION_ENUM = 
[
  EXPORT_DURATION_LAST_30_DAYS = 'LAST_30_DAYS'.freeze,
  EXPORT_DURATION_LAST_60_DAYS = 'LAST_60_DAYS'.freeze,
  EXPORT_DURATION_LAST_90_DAYS = 'LAST_90_DAYS'.freeze,
  EXPORT_DURATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
EXPORT_RESOURCES_ENUM = 
[
  EXPORT_RESOURCES_MANAGED_INSTANCE = 'MANAGED_INSTANCE'.freeze,
  EXPORT_RESOURCES_MANAGED_INSTANCE_PLUS_JAVA_RUNTIME = 'MANAGED_INSTANCE_PLUS_JAVA_RUNTIME'.freeze,
  EXPORT_RESOURCES_MANAGED_INSTANCE_PLUS_JAVA_RUNTIME_PLUS_APPLICATION = 'MANAGED_INSTANCE_PLUS_JAVA_RUNTIME_PLUS_APPLICATION'.freeze,
  EXPORT_RESOURCES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
EXPORT_FREQUENCY_ENUM = 
[
  EXPORT_FREQUENCY_DAILY = 'DAILY'.freeze,
  EXPORT_FREQUENCY_WEEKLY = 'WEEKLY'.freeze,
  EXPORT_FREQUENCY_MONTHLY = 'MONTHLY'.freeze,
  EXPORT_FREQUENCY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportSetting

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/jms/models/export_setting.rb', line 151

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

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

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

  self.fleet_id = attributes[:'fleetId'] if attributes[:'fleetId']

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

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

  self.export_duration = attributes[:'exportDuration'] if attributes[:'exportDuration']

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

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

  self.export_resources = attributes[:'exportResources'] if attributes[:'exportResources']

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

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

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

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

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

  self.target_bucket_name = attributes[:'targetBucketName'] if attributes[:'targetBucketName']

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

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

  self.target_bucket_namespace = attributes[:'targetBucketNamespace'] if attributes[:'targetBucketNamespace']

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

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

  self.target_bucket_region = attributes[:'targetBucketRegion'] if attributes[:'targetBucketRegion']

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

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

  self.export_frequency = attributes[:'exportFrequency'] if attributes[:'exportFrequency']

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

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

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_last_modified = attributes[:'timeLastModified'] if attributes[:'timeLastModified']

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

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

Instance Attribute Details

#export_duration ⇒ String

The duration of data to be exported for fleets.

Returns:

  • (String) 


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

def export_duration
  @export_duration
end

#export_frequency ⇒ String

Schedule at which data will be exported.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/jms/models/export_setting.rb', line 77

def export_frequency
  @export_frequency
end

#export_resources ⇒ String

Resource to export data associated from the fleets.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/jms/models/export_setting.rb', line 52

def export_resources
  @export_resources
end

#export_setting_key ⇒ String

The internal identifier of the export setting.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/jms/models/export_setting.rb', line 37

def export_setting_key
  @export_setting_key
end

#fleet_id ⇒ String

The OCID of the fleet.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/jms/models/export_setting.rb', line 42

def fleet_id
  @fleet_id
end

#is_cross_region_acknowledged ⇒ BOOLEAN

Acknowledgement for cross region target bucket configuration.

Returns:

  • (BOOLEAN) 


57
58
59
 
# File 'lib/oci/jms/models/export_setting.rb', line 57

def is_cross_region_acknowledged
  @is_cross_region_acknowledged
end

#is_enabled ⇒ BOOLEAN

[Required] ExportSetting flag to store enabled or disabled status.

Returns:

  • (BOOLEAN) 


81
82
83
 
# File 'lib/oci/jms/models/export_setting.rb', line 81

def is_enabled
  @is_enabled
end

#target_bucket_name ⇒ String

The name of the bucket where data will be exported.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/jms/models/export_setting.rb', line 62

def target_bucket_name
  @target_bucket_name
end

#target_bucket_namespace ⇒ String

The namespace of the bucket where data will be exported.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/jms/models/export_setting.rb', line 67

def target_bucket_namespace
  @target_bucket_namespace
end

#target_bucket_region ⇒ String

The namespace of the bucket where data will be exported.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/jms/models/export_setting.rb', line 72

def target_bucket_region
  @target_bucket_region
end

#time_created ⇒ DateTime

The creation date and time of the export setting (formatted according to RFC3339).

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/jms/models/export_setting.rb', line 86

def time_created
  @time_created
end

#time_last_modified ⇒ DateTime

The update date and time of the export setting (formatted according to RFC3339).

Returns:

  • (DateTime) 


91
92
93
 
# File 'lib/oci/jms/models/export_setting.rb', line 91

def time_last_modified
  @time_last_modified
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/jms/models/export_setting.rb', line 94

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'export_setting_key': :'exportSettingKey',
    'fleet_id': :'fleetId',
    'export_duration': :'exportDuration',
    'export_resources': :'exportResources',
    'is_cross_region_acknowledged': :'isCrossRegionAcknowledged',
    'target_bucket_name': :'targetBucketName',
    'target_bucket_namespace': :'targetBucketNamespace',
    'target_bucket_region': :'targetBucketRegion',
    'export_frequency': :'exportFrequency',
    'is_enabled': :'isEnabled',
    'time_created': :'timeCreated',
    'time_last_modified': :'timeLastModified'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/jms/models/export_setting.rb', line 114

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'export_setting_key': :'String',
    'fleet_id': :'String',
    'export_duration': :'String',
    'export_resources': :'String',
    'is_cross_region_acknowledged': :'BOOLEAN',
    'target_bucket_name': :'String',
    'target_bucket_namespace': :'String',
    'target_bucket_region': :'String',
    'export_frequency': :'String',
    'is_enabled': :'BOOLEAN',
    'time_created': :'DateTime',
    'time_last_modified': :'DateTime'
    # 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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/jms/models/export_setting.rb', line 280

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

  self.class == other.class &&
    export_setting_key == other.export_setting_key &&
    fleet_id == other.fleet_id &&
    export_duration == other.export_duration &&
    export_resources == other.export_resources &&
    is_cross_region_acknowledged == other.is_cross_region_acknowledged &&
    target_bucket_name == other.target_bucket_name &&
    target_bucket_namespace == other.target_bucket_namespace &&
    target_bucket_region == other.target_bucket_region &&
    export_frequency == other.export_frequency &&
    is_enabled == other.is_enabled &&
    time_created == other.time_created &&
    time_last_modified == other.time_last_modified
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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/oci/jms/models/export_setting.rb', line 321

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


301
302
303
 
# File 'lib/oci/jms/models/export_setting.rb', line 301

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



310
311
312
 
# File 'lib/oci/jms/models/export_setting.rb', line 310

def hash
  [export_setting_key, fleet_id, export_duration, export_resources, is_cross_region_acknowledged, target_bucket_name, target_bucket_namespace, target_bucket_region, export_frequency, is_enabled, time_created, time_last_modified].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



354
355
356
357
358
359
360
361
362
363
 
# File 'lib/oci/jms/models/export_setting.rb', line 354

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



348
349
350
 
# File 'lib/oci/jms/models/export_setting.rb', line 348

def to_s
  to_hash.to_s
end