Class: OCI::Streaming::Models::Archiver

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/streaming/models/archiver.rb

Overview

Represents the current state of the stream archiver.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_STOPPED = 'STOPPED'.freeze,
  LIFECYCLE_STATE_STARTING = 'STARTING'.freeze,
  LIFECYCLE_STATE_RUNNING = 'RUNNING'.freeze,
  LIFECYCLE_STATE_STOPPING = 'STOPPING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
START_POSITION_ENUM = 
[
  START_POSITION_LATEST = 'LATEST'.freeze,
  START_POSITION_TRIM_HORIZON = 'TRIM_HORIZON'.freeze,
  START_POSITION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Archiver

Initializes the object

Options Hash (attributes):



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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/streaming/models/archiver.rb', line 105

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

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

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

  self.bucket_name = attributes[:'bucketName'] if attributes[:'bucketName']

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

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

  self.use_existing_bucket = attributes[:'useExistingBucket'] unless attributes[:'useExistingBucket'].nil?

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

  self.use_existing_bucket = attributes[:'use_existing_bucket'] unless attributes[:'use_existing_bucket'].nil?

  self.start_position = attributes[:'startPosition'] if attributes[:'startPosition']

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

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

  self.batch_rollover_size_in_mbs = attributes[:'batchRolloverSizeInMBs'] if attributes[:'batchRolloverSizeInMBs']

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

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

  self.batch_rollover_time_in_seconds = attributes[:'batchRolloverTimeInSeconds'] if attributes[:'batchRolloverTimeInSeconds']

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

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

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

Instance Attribute Details

#batch_rollover_size_in_mbs ⇒ Integer

The batch rollover size in megabytes.



49
50
51
 
# File 'lib/oci/streaming/models/archiver.rb', line 49

def batch_rollover_size_in_mbs
  @batch_rollover_size_in_mbs
end

#batch_rollover_time_in_seconds ⇒ Integer

The rollover time in seconds.



53
54
55
 
# File 'lib/oci/streaming/models/archiver.rb', line 53

def batch_rollover_time_in_seconds
  @batch_rollover_time_in_seconds
end

#bucket_name ⇒ String

The name of the bucket.



37
38
39
 
# File 'lib/oci/streaming/models/archiver.rb', line 37

def bucket_name
  @bucket_name
end

#error ⇒ OCI::Streaming::Models::ArchiverError

If an operation failed this property contained the last error occurred.



57
58
59
 
# File 'lib/oci/streaming/models/archiver.rb', line 57

def error
  @error
end

#lifecycle_state ⇒ String

The state of the stream archiver.



33
34
35
 
# File 'lib/oci/streaming/models/archiver.rb', line 33

def lifecycle_state
  @lifecycle_state
end

#start_position ⇒ String

The start message.



45
46
47
 
# File 'lib/oci/streaming/models/archiver.rb', line 45

def start_position
  @start_position
end

#time_created ⇒ DateTime

Time when the resource was created.



29
30
31
 
# File 'lib/oci/streaming/models/archiver.rb', line 29

def time_created
  @time_created
end

#use_existing_bucket ⇒ BOOLEAN

The flag to create a new bucket or use existing one.



41
42
43
 
# File 'lib/oci/streaming/models/archiver.rb', line 41

def use_existing_bucket
  @use_existing_bucket
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/streaming/models/archiver.rb', line 60

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'bucket_name': :'bucketName',
    'use_existing_bucket': :'useExistingBucket',
    'start_position': :'startPosition',
    'batch_rollover_size_in_mbs': :'batchRolloverSizeInMBs',
    'batch_rollover_time_in_seconds': :'batchRolloverTimeInSeconds',
    'error': :'error'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/streaming/models/archiver.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'bucket_name': :'String',
    'use_existing_bucket': :'BOOLEAN',
    'start_position': :'String',
    'batch_rollover_size_in_mbs': :'Integer',
    'batch_rollover_time_in_seconds': :'Integer',
    'error': :'OCI::Streaming::Models::ArchiverError'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/streaming/models/archiver.rb', line 189

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

  self.class == other.class &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    bucket_name == other.bucket_name &&
    use_existing_bucket == other.use_existing_bucket &&
    start_position == other.start_position &&
    batch_rollover_size_in_mbs == other.batch_rollover_size_in_mbs &&
    batch_rollover_time_in_seconds == other.batch_rollover_time_in_seconds &&
    error == other.error
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/streaming/models/archiver.rb', line 226

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

See Also:

  • `==` method


206
207
208
 
# File 'lib/oci/streaming/models/archiver.rb', line 206

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



215
216
217
 
# File 'lib/oci/streaming/models/archiver.rb', line 215

def hash
  [time_created, lifecycle_state, bucket_name, use_existing_bucket, start_position, batch_rollover_size_in_mbs, batch_rollover_time_in_seconds, error].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/streaming/models/archiver.rb', line 259

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



253
254
255
 
# File 'lib/oci/streaming/models/archiver.rb', line 253

def to_s
  to_hash.to_s
end