Class: OCI::Streaming::Models::CreateArchiverDetails

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

Overview

Represents the parameters of the stream archiver.

Constant Summary collapse

START_POSITION_ENUM = 
[
  START_POSITION_LATEST = 'LATEST'.freeze,
  START_POSITION_TRIM_HORIZON = 'TRIM_HORIZON'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateArchiverDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 72

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.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']
end

Instance Attribute Details

#batch_rollover_size_in_mbs ⇒ Integer

[Required] The batch rollover size in megabytes.

Returns:

  • (Integer) 


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

def batch_rollover_size_in_mbs
  @batch_rollover_size_in_mbs
end

#batch_rollover_time_in_seconds ⇒ Integer

[Required] The rollover time in seconds.

Returns:

  • (Integer) 


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

def batch_rollover_time_in_seconds
  @batch_rollover_time_in_seconds
end

#bucket_name ⇒ String

[Required] The name of the bucket.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 17

def bucket_name
  @bucket_name
end

#start_position ⇒ String

[Required] The start message.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 25

def start_position
  @start_position
end

#use_existing_bucket ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


21
22
23
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 21

def use_existing_bucket
  @use_existing_bucket
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 36

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

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'bucket_name': :'String',
    'use_existing_bucket': :'BOOLEAN',
    'start_position': :'String',
    'batch_rollover_size_in_mbs': :'Integer',
    'batch_rollover_time_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



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 124

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

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 158

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


138
139
140
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 147

def hash
  [bucket_name, use_existing_bucket, start_position, batch_rollover_size_in_mbs, batch_rollover_time_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



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

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



185
186
187
 
# File 'lib/oci/streaming/models/create_archiver_details.rb', line 185

def to_s
  to_hash.to_s
end