Class CopyObjectDetails
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.objectstorage.model.CopyObjectDetails
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class CopyObjectDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelThe 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using theCopyObjectDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of theCopyObjectDetails.Builder, which maintain a set of all explicitly set fields calledCopyObjectDetails.Builder.__explicitlySet__. ThehashCode()andequals(Object)methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCopyObjectDetails.Builder
-
Constructor Summary
Constructors Constructor Description CopyObjectDetails(String sourceObjectName, String sourceObjectIfMatchETag, String sourceVersionId, String destinationRegion, String destinationNamespace, String destinationBucket, String destinationObjectName, String destinationObjectIfMatchETag, String destinationObjectIfNoneMatchETag, Map<String,String> destinationObjectMetadata, StorageTier destinationObjectStorageTier)Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CopyObjectDetails.Builderbuilder()Create a new builder.booleanequals(Object o)StringgetDestinationBucket()The destination bucket the object will be copied to.StringgetDestinationNamespace()The destination Object Storage namespace the object will be copied to.StringgetDestinationObjectIfMatchETag()The entity tag (ETag) to match against that of the destination object (an object intended to be overwritten).StringgetDestinationObjectIfNoneMatchETag()The entity tag (ETag) to avoid matching.Map<String,String>getDestinationObjectMetadata()Arbitrary string keys and values for the user-defined metadata for the object.StringgetDestinationObjectName()The name of the destination object resulting from the copy operation.StorageTiergetDestinationObjectStorageTier()The storage tier that the object should be stored in.StringgetDestinationRegion()The destination region the object will be copied to, for example “us-ashburn-1”.StringgetSourceObjectIfMatchETag()The entity tag (ETag) to match against that of the source object.StringgetSourceObjectName()The name of the object to be copied.StringgetSourceVersionId()VersionId of the object to copy.inthashCode()CopyObjectDetails.BuildertoBuilder()StringtoString()StringtoString(boolean includeByteArrayContents)Return a string representation of the object.
-
-
-
Constructor Detail
-
CopyObjectDetails
@Deprecated @ConstructorProperties({"sourceObjectName","sourceObjectIfMatchETag","sourceVersionId","destinationRegion","destinationNamespace","destinationBucket","destinationObjectName","destinationObjectIfMatchETag","destinationObjectIfNoneMatchETag","destinationObjectMetadata","destinationObjectStorageTier"}) public CopyObjectDetails(String sourceObjectName, String sourceObjectIfMatchETag, String sourceVersionId, String destinationRegion, String destinationNamespace, String destinationBucket, String destinationObjectName, String destinationObjectIfMatchETag, String destinationObjectIfNoneMatchETag, Map<String,String> destinationObjectMetadata, StorageTier destinationObjectStorageTier)
Deprecated.
-
-
Method Detail
-
builder
public static CopyObjectDetails.Builder builder()
Create a new builder.
-
toBuilder
public CopyObjectDetails.Builder toBuilder()
-
getSourceObjectName
public String getSourceObjectName()
The name of the object to be copied.- Returns:
- the value
-
getSourceObjectIfMatchETag
public String getSourceObjectIfMatchETag()
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.
- Returns:
- the value
-
getSourceVersionId
public String getSourceVersionId()
VersionId of the object to copy.If not provided then current version is copied by default.
- Returns:
- the value
-
getDestinationRegion
public String getDestinationRegion()
The destination region the object will be copied to, for example “us-ashburn-1”.- Returns:
- the value
-
getDestinationNamespace
public String getDestinationNamespace()
The destination Object Storage namespace the object will be copied to.- Returns:
- the value
-
getDestinationBucket
public String getDestinationBucket()
The destination bucket the object will be copied to.- Returns:
- the value
-
getDestinationObjectName
public String getDestinationObjectName()
The name of the destination object resulting from the copy operation.Avoid entering confidential information.
- Returns:
- the value
-
getDestinationObjectIfMatchETag
public String getDestinationObjectIfMatchETag()
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.
- Returns:
- the value
-
getDestinationObjectIfNoneMatchETag
public String getDestinationObjectIfNoneMatchETag()
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.
- Returns:
- the value
-
getDestinationObjectMetadata
public Map<String,String> getDestinationObjectMetadata()
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.
- Returns:
- the value
-
getDestinationObjectStorageTier
public StorageTier getDestinationObjectStorageTier()
The storage tier that the object should be stored in.If not specified, the object will be stored in the same storage tier as the bucket.
- Returns:
- the value
-
toString
public String toString()
- Overrides:
toStringin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equalsin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCodein classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-