jinbe/io.github.cchantep.jinbe/io.github.cchantep.jinbe.s3/WSS3BucketRef

WSS3BucketRef

io.github.cchantep.jinbe.s3.WSS3BucketRef

final class WSS3BucketRef extends BucketRef, BucketVersioning

Attributes

Graph
Supertypes: trait BucketVersioning

trait BucketRef

class Object

trait Matchable

class Any
Self type: WSS3BucketRef

Members list

Type members

Inherited classlikes

A request to delete the bucket.

Attributes

Inherited from:: BucketRef
Supertypes: class Object

trait Matchable

class Any

A request to list the objects inside this bucket.

Attributes

Inherited from:: BucketRef
Supertypes: class Object

trait Matchable

class Any

Prepares a request to list the bucket objects.

Attributes

Inherited from:: BucketVersioning
Supertypes: class Object

trait Matchable

class Any

Value members

Concrete methods

Attributes

See also: RESTBucketPUT

Prepares a request to delete the referenced bucket.

import akka.stream.Materializer

import io.github.cchantep.jinbe.BucketRef

def foo(myBucket: BucketRef)(implicit m: Materializer) =
 myBucket.delete() // .delete.apply()

def bar(myBucket: BucketRef)(implicit m: Materializer) =
 myBucket.delete.ignoreIfNotExists() // delete.ignoreIfNotExists.apply()

Attributes

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

It is reflexive: for any instance x of type Any, x.equals(x) should return true.
It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that: the object to compare against this object for equality.

Attributes

Returns: true if the receiver object is equivalent to the argument; false otherwise.
Definition Classes: Any

Attributes

See also: RESTBucketHEAD

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns: the hash code value for this object.
Definition Classes: Any

Checks whether the versioning is currently enabled or not on this bucket.

Attributes

Returns

A future with true if versioning is currently enabled, otherwise a future with false.

import scala.concurrent.ExecutionContext
import io.github.cchantep.jinbe.BucketVersioning
def foo(versioning: BucketVersioning)(implicit ec: ExecutionContext) =
 versioning.isVersioned

Returns a reference to an child object, specified by the given name.

Value parameters

objectName

the name of child object

import scala.concurrent.ExecutionContext
import io.github.cchantep.jinbe.BucketRef
def foo(myBucket: BucketRef)(implicit ec: ExecutionContext) =
 myBucket.obj("objInMyBucket").exists

Attributes

Gets a reference to a specific version of an object, allowing you to perform operations on an object version.

import io.github.cchantep.jinbe.BucketVersioning

def foo(versioning: BucketVersioning) =
 versioning.obj("objInBucket", "1.0")

Attributes

Prepares a request to list the bucket objects.

import akka.stream.Materializer
import io.github.cchantep.jinbe.BucketRef

def enumObjects(b: BucketRef)(implicit m: Materializer) = b.objects()

def objectList(b: BucketRef)(implicit m: Materializer) =
 b.objects.collect[List]()

Attributes

Enables or disables the versioning of objects on this bucket, existing versions history will not be erased when versioning is disabled.

import scala.concurrent.ExecutionContext
import io.github.cchantep.jinbe.BucketVersioning

def foo(versioning: BucketVersioning)(implicit ec: ExecutionContext) =
 versioning.setVersioning(true)

Attributes

Prepares a request to list the bucket versioned objects.

import akka.stream.Materializer
import io.github.cchantep.jinbe.BucketVersioning

def foo(versioning: BucketVersioning)(implicit m: Materializer) =
 versioning.versionedObjects()

Attributes

Try to get a reference of this bucket that would allow to perform versioning related operations.

Attributes

Returns

Some if the module of the bucket supports versioning related operations, otherwise None.

def foo(myBucket: io.github.cchantep.jinbe.BucketRef) =
 myBucket.versioning.isDefined

Concrete fields

The name of the bucket.

Attributes

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns: a string representation of the object.

In this article

Generated with