org.apache.flink.runtime.fs.s3

Class S3BucketObjectPair

java.lang.Object

org.apache.flink.runtime.fs.s3.S3BucketObjectPair

public final class S3BucketObjectPair
extends Object

An S3 bucket-object pair identifies either a bucket in S3 or an object. If the object property is null, this object identifies an S3 bucket. If both the bucket and the object property is null, the object refers to the S3 base directory.

This class is thread-safe.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBucket() Returns the name of the S3 bucket this object refers to.
String	getObject() Returns the name of the S3 object this object refers to.
boolean	hasBucket() Checks whether this object refers to an S3 bucket.
boolean	hasObject() Checks whether this object refers to an S3 object.

Methods inherited from class java.lang.Object

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

Method Detail

getBucket

public String getBucket()

Returns the name of the S3 bucket this object refers to.

Returns:

the name of the S3 bucket this object refers to or null if this object refers to the S3 base directory

getObject

public String getObject()

Returns the name of the S3 object this object refers to.

Returns:

the name of the S3 object this object refers to or null if this object refers to an S3 bucket

hasBucket

public boolean hasBucket()

Checks whether this object refers to an S3 bucket.

Returns:

true if this object refers to an S3 bucket, false otherwise directory

hasObject

public boolean hasObject()

Checks whether this object refers to an S3 object.

Returns:

true if this object refers to an S3 object, false otherwise