com.ibm.cloud.objectstorage.services.s3.model

Class S3ObjectId

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.model.S3ObjectId

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InstructionFileId

@Immutable
public class S3ObjectId
extends Object
implements Serializable

An Immutable S3 object identifier. Used to uniquely identify an S3 object. Can be instantiated directly, or via the convenient builder S3ObjectIdBuilder.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
S3ObjectId(S3ObjectIdBuilder builder)
S3ObjectId(String bucket, String key)
S3ObjectId(String bucket, String key, String versionId)

Method Summary

Modifier and Type	Method and Description
String	getBucket()
String	getKey()
String	getVersionId() Returns the version id which is optionally applicable for S3 get (but not put) operations.
InstructionFileId	instructionFileId() Returns the instruction file id of the default instruction file.
InstructionFileId	instructionFileId(String suffix) Returns the instruction file id of an instruction file with the given suffix.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

S3ObjectId

public S3ObjectId(String bucket,
                  String key)

S3ObjectId

public S3ObjectId(String bucket,
                  String key,
                  String versionId)

Parameters:

bucket - the S3 bucket name which must not be null

key - the S3 key name which must not be null

versionId - optional version id

S3ObjectId

public S3ObjectId(S3ObjectIdBuilder builder)

Parameters:

builder - must not be null.

Method Detail

getBucket

public String getBucket()

getKey

public String getKey()

getVersionId

public String getVersionId()

Returns the version id which is optionally applicable for S3 get (but not put) operations.

instructionFileId

public InstructionFileId instructionFileId()

Returns the instruction file id of the default instruction file.

instructionFileId

public InstructionFileId instructionFileId(String suffix)

Returns the instruction file id of an instruction file with the given suffix.

toString

public String toString()

Overrides:

toString in class Object