class OCI::ObjectStorage::Models::ReplicationPolicySummary

The summary of a replication policy.

Constants

STATUS_ENUM

Attributes

destination_bucket_name[RW]

[Required] The bucket to replicate to in the destination region. Replication policy creation does not automatically create a destination bucket. Create the destination bucket before creating the policy.

@return [String]

destination_region_name[RW]

[Required] The destination region to replicate to, for example "us-ashburn-1". @return [String]

id[RW]

[Required] The id of the replication policy. @return [String]

name[RW]

[Required] The name of the policy. @return [String]

status[R]

[Required] The replication status of the policy. If the status is CLIENT_ERROR, once the user fixes the issue described in the status message, the status will become ACTIVE.

@return [String]

status_message[RW]

[Required] A human-readable description of the status. @return [String]

time_created[RW]

[Required] The date when the replication policy was created as per [RFC 3339](tools.ietf.org/html/rfc3339).

@return [DateTime]

time_last_sync[RW]

[Required] Changes made to the source bucket before this time has been replicated.

@return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 56
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'destination_region_name': :'destinationRegionName',
    'destination_bucket_name': :'destinationBucketName',
    'time_created': :'timeCreated',
    'time_last_sync': :'timeLastSync',
    'status': :'status',
    'status_message': :'statusMessage'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :destination_region_name The value to assign to the {#destination_region_name} property @option attributes [String] :destination_bucket_name The value to assign to the {#destination_bucket_name} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_last_sync The value to assign to the {#time_last_sync} property @option attributes [String] :status The value to assign to the {#status} property @option attributes [String] :status_message The value to assign to the {#status_message} property

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 101
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.id = attributes[:'id'] if attributes[:'id']

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

  self.destination_region_name = attributes[:'destinationRegionName'] if attributes[:'destinationRegionName']

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

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

  self.destination_bucket_name = attributes[:'destinationBucketName'] if attributes[:'destinationBucketName']

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

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

  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_sync = attributes[:'timeLastSync'] if attributes[:'timeLastSync']

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

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

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

  self.status_message = attributes[:'statusMessage'] if attributes[:'statusMessage']

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

  self.status_message = attributes[:'status_message'] if attributes[:'status_message']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 72
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'destination_region_name': :'String',
    'destination_bucket_name': :'String',
    'time_created': :'DateTime',
    'time_last_sync': :'DateTime',
    'status': :'String',
    'status_message': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 164
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    destination_region_name == other.destination_region_name &&
    destination_bucket_name == other.destination_bucket_name &&
    time_created == other.time_created &&
    time_last_sync == other.time_last_sync &&
    status == other.status &&
    status_message == other.status_message
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 201
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 181
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 190
def hash
  [id, name, destination_region_name, destination_bucket_name, time_created, time_last_sync, status, status_message].hash
end
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 148
def status=(status)
  # rubocop:disable Style/ConditionalAssignment
  if status && !STATUS_ENUM.include?(status)
    OCI.logger.debug("Unknown value for 'status' [" + status + "]. Mapping to 'STATUS_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @status = STATUS_UNKNOWN_ENUM_VALUE
  else
    @status = status
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 234
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 228
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/object_storage/models/replication_policy_summary.rb, line 251
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end