Class: OCI::Opensearch::Models::ExportOpensearchClusterBackupDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb

Overview

Information about the cluster backup to export.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportOpensearchClusterBackupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :object_storage_namespace (String) —

    The value to assign to the #object_storage_namespace property

  • :object_storage_bucket_name (String) —

    The value to assign to the #object_storage_bucket_name property

  • :object_storage_prefix (String) —

    The value to assign to the #object_storage_prefix property

  • :snapshot_name (String) —

    The value to assign to the #snapshot_name property

  • :repository_name (String) —

    The value to assign to the #repository_name property

  • :prefix (String) —

    The value to assign to the #prefix property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



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

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

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

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

  self.object_storage_namespace = attributes[:'objectStorageNamespace'] if attributes[:'objectStorageNamespace']

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

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

  self.object_storage_bucket_name = attributes[:'objectStorageBucketName'] if attributes[:'objectStorageBucketName']

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

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

  self.object_storage_prefix = attributes[:'objectStoragePrefix'] if attributes[:'objectStoragePrefix']

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

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

  self.snapshot_name = attributes[:'snapshotName'] if attributes[:'snapshotName']

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

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

  self.repository_name = attributes[:'repositoryName'] if attributes[:'repositoryName']

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment where the Object Storage resources for the cluster backup are located.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 13

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


49
50
51
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 49

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


43
44
45
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 43

def freeform_tags
  @freeform_tags
end

#object_storage_bucket_name ⇒ String

[Required] The name of the Object Storage bucket for the cluster backup export operation.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 21

def object_storage_bucket_name
  @object_storage_bucket_name
end

#object_storage_namespace ⇒ String

[Required] The Object Storage namespace for the cluster backup export operation.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 17

def object_storage_namespace
  @object_storage_namespace
end

#object_storage_prefix ⇒ String

The prefix within the Object Storage bucket for the cluster backup export operation.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 25

def object_storage_prefix
  @object_storage_prefix
end

#prefix ⇒ String

[Required] The prefix within object storage bucket for the cluster backup export operation.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 37

def prefix
  @prefix
end

#repository_name ⇒ String

[Required] The name of the repository containing the snapshots for the cluster backup export operation.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 33

def repository_name
  @repository_name
end

#snapshot_name ⇒ String

[Required] The name of the snapshot for the cluster backup export operation.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 29

def snapshot_name
  @snapshot_name
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'object_storage_namespace': :'objectStorageNamespace',
    'object_storage_bucket_name': :'objectStorageBucketName',
    'object_storage_prefix': :'objectStoragePrefix',
    'snapshot_name': :'snapshotName',
    'repository_name': :'repositoryName',
    'prefix': :'prefix',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 69

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'object_storage_namespace': :'String',
    'object_storage_bucket_name': :'String',
    'object_storage_prefix': :'String',
    'snapshot_name': :'String',
    'repository_name': :'String',
    'prefix': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 164

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    object_storage_namespace == other.object_storage_namespace &&
    object_storage_bucket_name == other.object_storage_bucket_name &&
    object_storage_prefix == other.object_storage_prefix &&
    snapshot_name == other.snapshot_name &&
    repository_name == other.repository_name &&
    prefix == other.prefix &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 202

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


182
183
184
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 182

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 191

def hash
  [compartment_id, object_storage_namespace, object_storage_bucket_name, object_storage_prefix, snapshot_name, repository_name, prefix, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 235

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



229
230
231
 
# File 'lib/oci/opensearch/models/export_opensearch_cluster_backup_details.rb', line 229

def to_s
  to_hash.to_s
end