org.jclouds.s3.options
Class PutObjectOptions

java.lang.Object
  org.jclouds.http.options.BaseHttpRequestOptions
      org.jclouds.s3.options.PutObjectOptions

All Implemented Interfaces:

HttpRequestOptions

public class PutObjectOptions
extends BaseHttpRequestOptions

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

Usage

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

import static org.jclouds.s3.commands.options.PutObjectOptions.Builder.* import org.jclouds.s3.S3Client; S3Client connection = // get connection Future publicly readable = connection.putObject("bucketName",new S3Object("key","value"), withAcl(CannedAccessPolicy.PUBLIC_READ));

Author:

Adrian Cole

See Also:

Nested Class Summary

static class

PutObjectOptions.Builder

Field Summary

static PutObjectOptions

NONE

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

formParameters, headers, matrixParameters, pathSuffix, payload, queryParameters

Constructor Summary

PutObjectOptions()

Method Summary

com.google.common.collect.Multimap<String,String>	buildRequestHeaders() Builds headers representing options.
CannedAccessPolicy	getAcl()
void	setHeaderTag(String headerTag)
PutObjectOptions	withAcl(CannedAccessPolicy acl) Override the default ACL (private) with the specified one.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final PutObjectOptions NONE

Constructor Detail

PutObjectOptions

public PutObjectOptions()

Method Detail

setHeaderTag

@Inject
public void setHeaderTag(@Named(value="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.

withAcl

public PutObjectOptions withAcl(CannedAccessPolicy acl)

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

See Also:

CannedAccessPolicy

getAcl

public CannedAccessPolicy getAcl()

See Also:

withAcl(CannedAccessPolicy)