Package org.jclouds.s3.options

Class PutBucketOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.s3.options.PutBucketOptions

All Implemented Interfaces:

HttpRequestOptions

public class PutBucketOptions
extends BaseHttpRequestOptions

Contains options supported in the REST API for the PUT bucket operation.

Usage

The recommended way to instantiate a PutBucketOptions object is to statically import PutBucketOptions.Builder.* and invoke a static creation method followed by an instance mutator (if needed):

import static org.jclouds.s3.commands.options.PutBucketOptions.Builder.* import static org.jclouds.s3.domain.S3Bucket.Metadata.LocationConstraint.*; import org.jclouds.s3.S3Client;

S3Client connection = // get connection boolean createdInEu = connection.putBucketIfNotExists("bucketName",createIn(EU));

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutBucketOptions.Builder

Field Summary

Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor	Description
PutBucketOptions()

Method Summary

Modifier and Type	Method	Description
com.google.common.collect.Multimap<String,String>	buildRequestHeaders()	Builds headers representing options.
CannedAccessPolicy	getAcl()
void	setHeaderTag(String headerTag)
PutBucketOptions	withBucketAcl(CannedAccessPolicy acl)	Override the default ACL (private) with the specified one.

Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions

buildFormParameters, buildPathSuffix, buildQueryParameters, buildStringPayload, equals, getFirstFormOrNull, getFirstHeaderOrNull, getFirstQueryOrNull, hashCode, replaceHeader, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutBucketOptions

public PutBucketOptions()

Method Detail

setHeaderTag

@Inject
public void setHeaderTag(@Named("jclouds.aws.header.tag")
                         String headerTag)

buildRequestHeaders

public com.google.common.collect.Multimap<String,String> buildRequestHeaders()

Description copied from class: BaseHttpRequestOptions

Builds headers representing options.

Specified by:

buildRequestHeaders in interface HttpRequestOptions

Overrides:

buildRequestHeaders in class BaseHttpRequestOptions

Returns:

multimap that may contain headers.

withBucketAcl

public PutBucketOptions withBucketAcl(CannedAccessPolicy acl)

Override the default ACL (private) with the specified one.

See Also:

CannedAccessPolicy

getAcl

public CannedAccessPolicy getAcl()

See Also:

withBucketAcl(org.jclouds.s3.domain.CannedAccessPolicy)