Class: OCI::ObjectStorage::Models::CopyObjectDetails
- Inherits:
-
Object
- Object
- OCI::ObjectStorage::Models::CopyObjectDetails
- Defined in:
- lib/oci/object_storage/models/copy_object_details.rb
Overview
The parameters required by Object Storage to process a request to copy an object to another bucket.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Instance Attribute Summary collapse
-
#destination_bucket ⇒ String
[Required] The destination bucket the object will be copied to.
-
#destination_namespace ⇒ String
[Required] The destination Object Storage namespace the object will be copied to.
-
#destination_object_if_match_e_tag ⇒ String
The entity tag (ETag) to match against that of the destination object (an object intended to be overwritten).
-
#destination_object_if_none_match_e_tag ⇒ String
The entity tag (ETag) to avoid matching.
-
#destination_object_metadata ⇒ Hash<String, String>
Arbitrary string keys and values for the user-defined metadata for the object.
-
#destination_object_name ⇒ String
[Required] The name of the destination object resulting from the copy operation.
-
#destination_region ⇒ String
[Required] The destination region the object will be copied to, for example "us-ashburn-1".
-
#source_object_if_match_e_tag ⇒ String
The entity tag (ETag) to match against that of the source object.
-
#source_object_name ⇒ String
[Required] The name of the object to be copied.
-
#source_version_id ⇒ String
VersionId of the object to copy.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CopyObjectDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CopyObjectDetails
Initializes the object
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 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 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 118 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.source_object_name = attributes[:'sourceObjectName'] if attributes[:'sourceObjectName'] raise 'You cannot provide both :sourceObjectName and :source_object_name' if attributes.key?(:'sourceObjectName') && attributes.key?(:'source_object_name') self.source_object_name = attributes[:'source_object_name'] if attributes[:'source_object_name'] self.source_object_if_match_e_tag = attributes[:'sourceObjectIfMatchETag'] if attributes[:'sourceObjectIfMatchETag'] raise 'You cannot provide both :sourceObjectIfMatchETag and :source_object_if_match_e_tag' if attributes.key?(:'sourceObjectIfMatchETag') && attributes.key?(:'source_object_if_match_e_tag') self.source_object_if_match_e_tag = attributes[:'source_object_if_match_e_tag'] if attributes[:'source_object_if_match_e_tag'] self.source_version_id = attributes[:'sourceVersionId'] if attributes[:'sourceVersionId'] raise 'You cannot provide both :sourceVersionId and :source_version_id' if attributes.key?(:'sourceVersionId') && attributes.key?(:'source_version_id') self.source_version_id = attributes[:'source_version_id'] if attributes[:'source_version_id'] self.destination_region = attributes[:'destinationRegion'] if attributes[:'destinationRegion'] raise 'You cannot provide both :destinationRegion and :destination_region' if attributes.key?(:'destinationRegion') && attributes.key?(:'destination_region') self.destination_region = attributes[:'destination_region'] if attributes[:'destination_region'] self.destination_namespace = attributes[:'destinationNamespace'] if attributes[:'destinationNamespace'] raise 'You cannot provide both :destinationNamespace and :destination_namespace' if attributes.key?(:'destinationNamespace') && attributes.key?(:'destination_namespace') self.destination_namespace = attributes[:'destination_namespace'] if attributes[:'destination_namespace'] self.destination_bucket = attributes[:'destinationBucket'] if attributes[:'destinationBucket'] raise 'You cannot provide both :destinationBucket and :destination_bucket' if attributes.key?(:'destinationBucket') && attributes.key?(:'destination_bucket') self.destination_bucket = attributes[:'destination_bucket'] if attributes[:'destination_bucket'] self.destination_object_name = attributes[:'destinationObjectName'] if attributes[:'destinationObjectName'] raise 'You cannot provide both :destinationObjectName and :destination_object_name' if attributes.key?(:'destinationObjectName') && attributes.key?(:'destination_object_name') self.destination_object_name = attributes[:'destination_object_name'] if attributes[:'destination_object_name'] self.destination_object_if_match_e_tag = attributes[:'destinationObjectIfMatchETag'] if attributes[:'destinationObjectIfMatchETag'] raise 'You cannot provide both :destinationObjectIfMatchETag and :destination_object_if_match_e_tag' if attributes.key?(:'destinationObjectIfMatchETag') && attributes.key?(:'destination_object_if_match_e_tag') self.destination_object_if_match_e_tag = attributes[:'destination_object_if_match_e_tag'] if attributes[:'destination_object_if_match_e_tag'] self.destination_object_if_none_match_e_tag = attributes[:'destinationObjectIfNoneMatchETag'] if attributes[:'destinationObjectIfNoneMatchETag'] raise 'You cannot provide both :destinationObjectIfNoneMatchETag and :destination_object_if_none_match_e_tag' if attributes.key?(:'destinationObjectIfNoneMatchETag') && attributes.key?(:'destination_object_if_none_match_e_tag') self.destination_object_if_none_match_e_tag = attributes[:'destination_object_if_none_match_e_tag'] if attributes[:'destination_object_if_none_match_e_tag'] self. = attributes[:'destinationObjectMetadata'] if attributes[:'destinationObjectMetadata'] raise 'You cannot provide both :destinationObjectMetadata and :destination_object_metadata' if attributes.key?(:'destinationObjectMetadata') && attributes.key?(:'destination_object_metadata') self. = attributes[:'destination_object_metadata'] if attributes[:'destination_object_metadata'] end |
Instance Attribute Details
#destination_bucket ⇒ String
[Required] The destination bucket the object will be copied to.
39 40 41 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 39 def destination_bucket @destination_bucket end |
#destination_namespace ⇒ String
[Required] The destination Object Storage namespace the object will be copied to.
35 36 37 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 35 def destination_namespace @destination_namespace end |
#destination_object_if_match_e_tag ⇒ String
The entity tag (ETag) to match against that of the destination object (an object intended to be overwritten). Used to confirm that the destination object stored under a given name is the version of that object storing a specified entity tag.
50 51 52 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 50 def destination_object_if_match_e_tag @destination_object_if_match_e_tag end |
#destination_object_if_none_match_e_tag ⇒ String
The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail if the object already exists in the destination bucket.
56 57 58 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 56 def destination_object_if_none_match_e_tag @destination_object_if_none_match_e_tag end |
#destination_object_metadata ⇒ Hash<String, String>
Arbitrary string keys and values for the user-defined metadata for the object. Keys must be in "opc-meta-*" format. Avoid entering confidential information. Metadata key-value pairs entered in this field are assigned to the destination object. If you enter no metadata values, the destination object will inherit any existing metadata values associated with the source object.
64 65 66 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 64 def @destination_object_metadata end |
#destination_object_name ⇒ String
[Required] The name of the destination object resulting from the copy operation.
43 44 45 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 43 def destination_object_name @destination_object_name end |
#destination_region ⇒ String
[Required] The destination region the object will be copied to, for example "us-ashburn-1".
31 32 33 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 31 def destination_region @destination_region end |
#source_object_if_match_e_tag ⇒ String
The entity tag (ETag) to match against that of the source object. Used to confirm that the source object with a given name is the version of that object storing a specified ETag.
23 24 25 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 23 def source_object_if_match_e_tag @source_object_if_match_e_tag end |
#source_object_name ⇒ String
[Required] The name of the object to be copied.
17 18 19 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 17 def source_object_name @source_object_name end |
#source_version_id ⇒ String
VersionId of the object to copy. If not provided then current version is copied by default.
27 28 29 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 27 def source_version_id @source_version_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 67 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'source_object_name': :'sourceObjectName', 'source_object_if_match_e_tag': :'sourceObjectIfMatchETag', 'source_version_id': :'sourceVersionId', 'destination_region': :'destinationRegion', 'destination_namespace': :'destinationNamespace', 'destination_bucket': :'destinationBucket', 'destination_object_name': :'destinationObjectName', 'destination_object_if_match_e_tag': :'destinationObjectIfMatchETag', 'destination_object_if_none_match_e_tag': :'destinationObjectIfNoneMatchETag', 'destination_object_metadata': :'destinationObjectMetadata' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 85 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'source_object_name': :'String', 'source_object_if_match_e_tag': :'String', 'source_version_id': :'String', 'destination_region': :'String', 'destination_namespace': :'String', 'destination_bucket': :'String', 'destination_object_name': :'String', 'destination_object_if_match_e_tag': :'String', 'destination_object_if_none_match_e_tag': :'String', 'destination_object_metadata': :'Hash<String, String>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 192 def ==(other) return true if equal?(other) self.class == other.class && source_object_name == other.source_object_name && source_object_if_match_e_tag == other.source_object_if_match_e_tag && source_version_id == other.source_version_id && destination_region == other.destination_region && destination_namespace == other.destination_namespace && destination_bucket == other.destination_bucket && destination_object_name == other.destination_object_name && destination_object_if_match_e_tag == other.destination_object_if_match_e_tag && destination_object_if_none_match_e_tag == other.destination_object_if_none_match_e_tag && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 231 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
211 212 213 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 211 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
220 221 222 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 220 def hash [source_object_name, source_object_if_match_e_tag, source_version_id, destination_region, destination_namespace, destination_bucket, destination_object_name, destination_object_if_match_e_tag, destination_object_if_none_match_e_tag, ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
264 265 266 267 268 269 270 271 272 273 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 264 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
258 259 260 |
# File 'lib/oci/object_storage/models/copy_object_details.rb', line 258 def to_s to_hash.to_s end |