com.emc.vipr.client.core

Class ObjectBuckets

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

com.emc.vipr.client.core.AbstractCoreBulkResources<T>

com.emc.vipr.client.core.ProjectResources<BucketRestRep>

com.emc.vipr.client.core.ObjectBuckets

All Implemented Interfaces:

BulkResources<BucketRestRep>, Resources<BucketRestRep>, TaskResources<BucketRestRep>

public class ObjectBuckets
extends ProjectResources<BucketRestRep>
implements TaskResources<BucketRestRep>

ObjectBuckets resources.

Base URL: /object/buckets

Constructor Summary

Constructors

Constructor and Description
ObjectBuckets(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<BucketRestRep>	create(BucketParam input, java.net.URI project) Begins create the bucket.
Task<BucketRestRep>	deactivate(java.net.URI id, BucketDeleteParam input) Begins deactivating the given bucket by ID.
Task<BucketRestRep>	deleteBucketACL(java.net.URI id) Begins removing a bucket ACL from the given bucket by ID.
java.util.List<BucketACE>	getBucketACL(java.net.URI id) Gets the Bucket ACLs for the given bucket by ID.
Task<BucketRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<BucketRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
Task<BucketRestRep>	update(java.net.URI id, BucketUpdateParam input) Begins update the bucket.
Task<BucketRestRep>	updateBucketACL(java.net.URI id, ObjectBucketACLUpdateParams param) Update Bucket ACL API Call: PUT /object/buckets/{id}/acl/

Methods inherited from class com.emc.vipr.client.core.ProjectResources

findByProject, findByProject, findByProject, findByProject, search

Methods inherited from class com.emc.vipr.client.core.AbstractBulkResources

getByIds, getByRefs, listBulkIds

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, updateTags, withInactive, withInternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, updateTags

Constructor Detail

ObjectBuckets

public ObjectBuckets(ViPRCoreClient parent,
                     RestClient client)

Method Detail

getTasks

public Tasks<BucketRestRep> getTasks(java.net.URI id)

Description copied from interface: TaskResources

Gets the tasks associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks

Specified by:

getTasks in interface TaskResources<BucketRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<BucketRestRep> getTask(java.net.URI id,
                                   java.net.URI taskId)

Description copied from interface: TaskResources

Gets a single task associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks/{taskId}

Specified by:

getTask in interface TaskResources<BucketRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

deactivate

public Task<BucketRestRep> deactivate(java.net.URI id,
                                      BucketDeleteParam input)

Begins deactivating the given bucket by ID.

API Call: POST /object/buckets/{id}/deactivate

Parameters:

id - the ID of the file system to deactivate.

input - the delete configuration.

Returns:

a task for monitoring the progress of the operation.

create

public Task<BucketRestRep> create(BucketParam input,
                                  java.net.URI project)

Begins create the bucket.

API Call: POST /object/buckets

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

update

public Task<BucketRestRep> update(java.net.URI id,
                                  BucketUpdateParam input)

Begins update the bucket.

API Call: PUT /object/buckets

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

getBucketACL

public java.util.List<BucketACE> getBucketACL(java.net.URI id)

Gets the Bucket ACLs for the given bucket by ID.

API Call: GET /object/buckets/{id}/acl/

Parameters:

id - is the ID of the file system.

Returns:

the list of ACE for the given bucket.

updateBucketACL

public Task<BucketRestRep> updateBucketACL(java.net.URI id,
                                           ObjectBucketACLUpdateParams param)

Update Bucket ACL API Call: PUT /object/buckets/{id}/acl/

Parameters:

id - is the ID of the Bucket.

param - the update/create configuration

Returns:

a task for monitoring the progress of the operation.

deleteBucketACL

public Task<BucketRestRep> deleteBucketACL(java.net.URI id)

Begins removing a bucket ACL from the given bucket by ID.

API Call: DELETE /object/buckets/{id}/acl/

Parameters:

id - is the ID of the Bucket.

Returns:

a task for monitoring the progress of the operation.