ObjectApi (Apache jclouds 2.1.0 API)

Methods
Modifier and Type	Method and Description
`GoogleCloudStorageObject`	`composeObjects(String destinationBucket, String destinationObject, ComposeObjectTemplate composeObjectTemplate)` Concatenates a list of existing objects into a new object in the same bucket.
`GoogleCloudStorageObject`	`composeObjects(String destinationBucket, String destinationObject, ComposeObjectTemplate composeObjectTemplate, ComposeObjectOptions options)` Concatenates a list of existing objects into a new object in the same bucket.
`GoogleCloudStorageObject`	`copyObject(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject)` Copies an object to a specified location.
`GoogleCloudStorageObject`	`copyObject(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject, CopyObjectOptions options)` Copies an object to a specified location.
`GoogleCloudStorageObject`	`copyObject(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject, ObjectTemplate template)` Copies an object to a specified location with updated metadata.
`boolean`	`deleteObject(String bucketName, String objectName)` Deletes an object and its metadata.
`boolean`	`deleteObject(String bucketName, String objectName, DeleteObjectOptions options)` Deletes an object and its metadata.
`PayloadEnclosing`	`download(String bucketName, String objectName)` Retrieve an object or their metadata
`PayloadEnclosing`	`download(String bucketName, String objectName, HttpRequestOptions options)` Retrieves objects
`GoogleCloudStorageObject`	`getObject(String bucketName, String objectName)` Retrieve an object metadata
`GoogleCloudStorageObject`	`getObject(String bucketName, String objectName, HttpRequestOptions options)` Retrieves objects metadata
`ListPageWithPrefixes<GoogleCloudStorageObject>`	`listObjects(String bucketName)` Retrieves a list of objects matching the criteria.
`ListPageWithPrefixes<GoogleCloudStorageObject>`	`listObjects(String bucketName, ListObjectOptions options)` Retrieves a list of objects matching the criteria.
`GoogleCloudStorageObject`	`multipartUpload(String bucketName, ObjectTemplate objectTemplate, Payload payload)` Stores a new object with metadata.
`boolean`	`objectExists(String bucketName, String objectName)` Check the existence of an object
`GoogleCloudStorageObject`	`patchObject(String bucketName, String objectName, ObjectTemplate objectTemplate)` Updates an object according to patch semantics
`GoogleCloudStorageObject`	`patchObject(String bucketName, String objectName, ObjectTemplate objectTemplate, UpdateObjectOptions options)` Updates an object according to patch semantics
`RewriteResponse`	`rewriteObjects(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject)` Rewrites a source object to a destination object.
`RewriteResponse`	`rewriteObjects(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject, RewriteObjectOptions options)` Rewrites a source object to a destination object.
`GoogleCloudStorageObject`	`simpleUpload(String bucketName, String contentType, Long contentLength, Payload payload, InsertObjectOptions options)` Stores a new object.
`GoogleCloudStorageObject`	`updateObject(String bucketName, String objectName, ObjectTemplate objectTemplate)` Updates an object metadata
`GoogleCloudStorageObject`	`updateObject(String bucketName, String objectName, ObjectTemplate objectTemplate, UpdateObjectOptions options)` Updates an object

```
public interface ObjectApi
```
Provides access to Object entities via their REST API.

See Also:

Method Summary

Methods
Modifier and Type Method and Description

GoogleCloudStorageObject composeObjects(String destinationBucket, String destinationObject, ComposeObjectTemplate composeObjectTemplate)
Concatenates a list of existing objects into a new object in the same bucket.

GoogleCloudStorageObject composeObjects(String destinationBucket, String destinationObject, ComposeObjectTemplate composeObjectTemplate, ComposeObjectOptions options)
Concatenates a list of existing objects into a new object in the same bucket.

GoogleCloudStorageObject copyObject(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject)
Copies an object to a specified location.

GoogleCloudStorageObject copyObject(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject, CopyObjectOptions options)
Copies an object to a specified location.

GoogleCloudStorageObject copyObject(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject, ObjectTemplate template)
Copies an object to a specified location with updated metadata.

boolean deleteObject(String bucketName, String objectName)
Deletes an object and its metadata.

boolean deleteObject(String bucketName, String objectName, DeleteObjectOptions options)
Deletes an object and its metadata.

PayloadEnclosing download(String bucketName, String objectName)
Retrieve an object or their metadata

PayloadEnclosing download(String bucketName, String objectName, HttpRequestOptions options)
Retrieves objects

GoogleCloudStorageObject getObject(String bucketName, String objectName)
Retrieve an object metadata

GoogleCloudStorageObject getObject(String bucketName, String objectName, HttpRequestOptions options)
Retrieves objects metadata

ListPageWithPrefixes<GoogleCloudStorageObject> listObjects(String bucketName)
Retrieves a list of objects matching the criteria.

ListPageWithPrefixes<GoogleCloudStorageObject> listObjects(String bucketName, ListObjectOptions options)
Retrieves a list of objects matching the criteria.

GoogleCloudStorageObject multipartUpload(String bucketName, ObjectTemplate objectTemplate, Payload payload)
Stores a new object with metadata.

boolean objectExists(String bucketName, String objectName)
Check the existence of an object

GoogleCloudStorageObject patchObject(String bucketName, String objectName, ObjectTemplate objectTemplate)
Updates an object according to patch semantics

GoogleCloudStorageObject patchObject(String bucketName, String objectName, ObjectTemplate objectTemplate, UpdateObjectOptions options)
Updates an object according to patch semantics

RewriteResponse rewriteObjects(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject)
Rewrites a source object to a destination object.

RewriteResponse rewriteObjects(String destinationBucket, String destinationObject, String sourceBucket, String sourceObject, RewriteObjectOptions options)
Rewrites a source object to a destination object.

GoogleCloudStorageObject simpleUpload(String bucketName, String contentType, Long contentLength, Payload payload, InsertObjectOptions options)
Stores a new object.

GoogleCloudStorageObject updateObject(String bucketName, String objectName, ObjectTemplate objectTemplate)
Updates an object metadata

GoogleCloudStorageObject updateObject(String bucketName, String objectName, ObjectTemplate objectTemplate, UpdateObjectOptions options)
Updates an object

Method Detail

objectExists

@Named(value="Object:Exist")
@GET
@Path(value="storage/v1/b/{bucket}/o/{object}")
boolean objectExists(@PathParam(value="bucket")
                                  String bucketName,
                                  @PathParam(value="object")@Encoded
                                  String objectName)

Check the existence of an object

Parameters:: bucketName - Name of the bucket in which the object resides; objectName - Name of the object
Returns:: a Object true if object exists

getObject

@Named(value="Object:get")
@GET
@Path(value="storage/v1/b/{bucket}/o/{object}")
@Consumes(value="application/json")
@Nullable
GoogleCloudStorageObject getObject(@PathParam(value="bucket")
                                                                  String bucketName,
                                                                  @PathParam(value="object")@Encoded
                                                                  String objectName)

Retrieve an object metadata

Parameters:: bucketName - Name of the bucket in which the object resides; objectName - Name of the object
Returns:: a Object resource

getObject

@Named(value="Object:get")
@GET
@Path(value="storage/v1/b/{bucket}/o/{object}")
@Consumes(value="application/json")
@Nullable
GoogleCloudStorageObject getObject(@PathParam(value="bucket")
                                                                  String bucketName,
                                                                  @PathParam(value="object")@Encoded
                                                                  String objectName,
                                                                  HttpRequestOptions options)

Retrieves objects metadata

Parameters:: bucketName - Name of the bucket in which the object resides; objectName - Name of the object; options - A class that implements HttpRequestOptions such as GetObjectOptions with optional query parameters
Returns:: a GoogleCloudStorageObject

download

@Named(value="Object:get")
@GET
@Path(value="storage/v1/b/{bucket}/o/{object}")
@Nullable
PayloadEnclosing download(@PathParam(value="bucket")
                                                String bucketName,
                                                @PathParam(value="object")@Encoded
                                                String objectName)

Retrieve an object or their metadata

Parameters:: bucketName - Name of the bucket in which the object resides; objectName - Name of the object
Returns:: a Object resource

download

@Named(value="Object:get")
@GET
@Path(value="storage/v1/b/{bucket}/o/{object}")
@Nullable
PayloadEnclosing download(@PathParam(value="bucket")
                                                String bucketName,
                                                @PathParam(value="object")@Encoded
                                                String objectName,
                                                HttpRequestOptions options)

Retrieves objects

Parameters:: bucketName - Name of the bucket in which the object resides; objectName - Name of the object; options - A class that implements HttpRequestOptions such as GetObjectOptions with optional query parameters
Returns:: a GoogleCloudStorageObject

simpleUpload

@Named(value="Object:simpleUpload")
@POST
@Consumes(value="application/json")
@Path(value="/upload/storage/v1/b/{bucket}/o")
GoogleCloudStorageObject simpleUpload(@PathParam(value="bucket")
                                                             String bucketName,
                                                             @HeaderParam(value="Content-Type")
                                                             String contentType,
                                                             @HeaderParam(value="Content-Length")
                                                             Long contentLength,
                                                             Payload payload,
                                                             InsertObjectOptions options)

Stores a new object. Object metadata setting is not supported with simple uploads

Parameters:: bucketName - Name of the bucket in which the object to be stored; options - Supply an InsertObjectOptions. 'name' should not null.
Returns:: a GoogleCloudStorageObject
See Also:: https://developers.google.com/storage/docs/json_api/v1/how-tos/upload#simple

deleteObject

@Named(value="Object:delete")
@DELETE
@Path(value="storage/v1/b/{bucket}/o/{object}")
boolean deleteObject(@PathParam(value="bucket")
                                     String bucketName,
                                     @PathParam(value="object")@Encoded
                                     String objectName)

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled.

Parameters:: bucketName - Name of the bucket in which the object to be deleted resides; objectName - Name of the object

deleteObject

@Named(value="Object:delete")
@DELETE
@Path(value="storage/v1/b/{bucket}/o/{object}")
boolean deleteObject(@PathParam(value="bucket")
                                     String bucketName,
                                     @PathParam(value="object")@Encoded
                                     String objectName,
                                     DeleteObjectOptions options)

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.

Parameters:: bucketName - Name of the bucket in which the object to be deleted resides; objectName - Name of the object; options - Supply DeleteObjectOptions with optional query parameters

listObjects

@Named(value="Object:list")
@GET
@Consumes(value="application/json")
@Path(value="storage/v1/b/{bucket}/o")
ListPageWithPrefixes<GoogleCloudStorageObject> listObjects(@PathParam(value="bucket")
                                                                                 String bucketName)

Retrieves a list of objects matching the criteria.

Parameters:: bucketName - Name of the bucket in which to look for objects.

listObjects

@Named(value="Object:list")
@GET
@Consumes(value="application/json")
@Path(value="storage/v1/b/{bucket}/o")
ListPageWithPrefixes<GoogleCloudStorageObject> listObjects(@PathParam(value="bucket")
                                                                                 String bucketName,
                                                                                 ListObjectOptions options)

Retrieves a list of objects matching the criteria.

Parameters:: bucketName - Name of the bucket in which to look for objects.; options - Supply ListObjectOptions
Returns:: a ListPage

updateObject

@Named(value="Object:update")
@PUT
@Consumes(value="application/json")
@Produces(value="application/json")
@Path(value="storage/v1/b/{bucket}/o/{object}")
GoogleCloudStorageObject updateObject(@PathParam(value="bucket")
                                                                     String bucketName,
                                                                     @PathParam(value="object")@Encoded
                                                                     String objectName,
                                                                     ObjectTemplate objectTemplate)

Updates an object metadata

Parameters:: bucketName - Name of the bucket in which the object resides; objectName - Name of the object; objectTemplate - Supply an ObjectTemplate
Returns:: a GoogleCloudStorageObject

updateObject

@Named(value="Object:update")
@PUT
@Consumes(value="application/json")
@Produces(value="application/json")
@Path(value="storage/v1/b/{bucket}/o/{object}")
GoogleCloudStorageObject updateObject(@PathParam(value="bucket")
                                                                     String bucketName,
                                                                     @PathParam(value="object")@Encoded
                                                                     String objectName,
                                                                     ObjectTemplate objectTemplate,
                                                                     UpdateObjectOptions options)

Updates an object

Parameters:: bucketName - Name of the bucket in which the object resides; objectName - Name of the object; objectTemplate - Supply anObjectTemplate; options - Supply UpdateObjectOptions with optional query parameters
Returns:: a GoogleCloudStorageObject .

patchObject

@Named(value="Object:patch")
@Consumes(value="application/json")
@Produces(value="application/json")
@Path(value="storage/v1/b/{bucket}/o/{object}")
GoogleCloudStorageObject patchObject(@PathParam(value="bucket")
                                                                String bucketName,
                                                                @PathParam(value="object")@Encoded
                                                                String objectName,
                                                                ObjectTemplate objectTemplate)

Updates an object according to patch semantics

Parameters:: bucketName - Name of the bucket in which the object resides; objectName - Name of the object; objectTemplate - Supply ObjectTemplate with optional query parameters
Returns:: a GoogleCloudStorageObject

patchObject

@Named(value="Object:patch")
@PUT
@Consumes(value="application/json")
@Produces(value="application/json")
@Path(value="storage/v1/b/{bucket}/o/{object}")
GoogleCloudStorageObject patchObject(@PathParam(value="bucket")
                                                                    String bucketName,
                                                                    @PathParam(value="object")@Encoded
                                                                    String objectName,
                                                                    ObjectTemplate objectTemplate,
                                                                    UpdateObjectOptions options)

Updates an object according to patch semantics

Parameters:: bucketName - Name of the bucket in which the object resides; objectName - Name of the object; objectTemplate - Supply ObjectTemplate with optional query parameters; options - Supply UpdateObjectOptions with optional query parameters
Returns:: a GoogleCloudStorageObject

composeObjects

@Named(value="Object:compose")
@POST
@Consumes(value="application/json")
@Path(value="storage/v1/b/{destinationBucket}/o/{destinationObject}/compose")
GoogleCloudStorageObject composeObjects(@PathParam(value="destinationBucket")
                                                               String destinationBucket,
                                                               @PathParam(value="destinationObject")@Encoded
                                                               String destinationObject,
                                                               ComposeObjectTemplate composeObjectTemplate)

Concatenates a list of existing objects into a new object in the same bucket.

Parameters:: destinationBucket - Name of the bucket in which the object to be stored; destinationObject - The type of upload request.; composeObjectTemplate - Supply a ComposeObjectTemplate
Returns:: a GoogleCloudStorageObject

composeObjects

@Named(value="Object:compose")
@POST
@Consumes(value="application/json")
@Path(value="storage/v1/b/{destinationBucket}/o/{destinationObject}/compose")
GoogleCloudStorageObject composeObjects(@PathParam(value="destinationBucket")
                                                               String destinationBucket,
                                                               @PathParam(value="destinationObject")@Encoded
                                                               String destinationObject,
                                                               ComposeObjectTemplate composeObjectTemplate,
                                                               ComposeObjectOptions options)

Concatenates a list of existing objects into a new object in the same bucket.

Parameters:: destinationBucket - Name of the bucket in which the object to be stored; destinationObject - The type of upload request.; composeObjectTemplate - Supply a ComposeObjectTemplate; options - Supply an ComposeObjectOptions
Returns:: a GoogleCloudStorageObject

copyObject

@Named(value="Object:copy")
@POST
@Consumes(value="application/json")
@Path(value="/storage/v1/b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}")
GoogleCloudStorageObject copyObject(@PathParam(value="destinationBucket")
                                                           String destinationBucket,
                                                           @PathParam(value="destinationObject")@Encoded
                                                           String destinationObject,
                                                           @PathParam(value="sourceBucket")
                                                           String sourceBucket,
                                                           @PathParam(value="sourceObject")@Encoded
                                                           String sourceObject)

Copies an object to a specified location.

Parameters:: destinationBucket - Name of the bucket in which to store the new object; destinationObject - Name of the new object.; sourceBucket - Name of the bucket in which to find the source object; sourceObject - Name of the source object
Returns:: a GoogleCloudStorageObject

copyObject

@Named(value="Object:copy")
@POST
@Consumes(value="application/json")
@Path(value="/storage/v1/b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}")
GoogleCloudStorageObject copyObject(@PathParam(value="destinationBucket")
                                                           String destinationBucket,
                                                           @PathParam(value="destinationObject")@Encoded
                                                           String destinationObject,
                                                           @PathParam(value="sourceBucket")
                                                           String sourceBucket,
                                                           @PathParam(value="sourceObject")@Encoded
                                                           String sourceObject,
                                                           ObjectTemplate template)

Copies an object to a specified location with updated metadata.

Parameters:: destinationBucket - Name of the bucket in which to store the new object; destinationObject - Name of the new object.; sourceBucket - Name of the bucket in which to find the source object; sourceObject - Name of the source object; template - Supply a CopyObjectOptions
Returns:: a GoogleCloudStorageObject

copyObject

@Named(value="Object:copy")
@POST
@Consumes(value="application/json")
@Path(value="/storage/v1/b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}")
GoogleCloudStorageObject copyObject(@PathParam(value="destinationBucket")
                                                           String destinationBucket,
                                                           @PathParam(value="destinationObject")@Encoded
                                                           String destinationObject,
                                                           @PathParam(value="sourceBucket")
                                                           String sourceBucket,
                                                           @PathParam(value="sourceObject")@Encoded
                                                           String sourceObject,
                                                           CopyObjectOptions options)

Copies an object to a specified location. Optionally overrides metadata.

Parameters:: destinationBucket - Name of the bucket in which to store the new object; destinationObject - Name of the new object.; sourceBucket - Name of the bucket in which to find the source object; sourceObject - Name of the source object; options - Supply a CopyObjectOptions
Returns:: a GoogleCloudStorageObject

multipartUpload

@Named(value="Object:multipartUpload")
@POST
@Consumes(value="application/json")
@Path(value="/upload/storage/v1/b/{bucket}/o")
GoogleCloudStorageObject multipartUpload(@PathParam(value="bucket")
                                                                String bucketName,
                                                                ObjectTemplate objectTemplate,
                                                                Payload payload)

Stores a new object with metadata.

Parameters:: bucketName - Name of the bucket in which the object to be stored; objectTemplate - Supply an ObjectTemplate.
Returns:: a GoogleCloudStorageObject
See Also:: https://developers.google.com/storage/docs/json_api/v1/how-tos/upload#multipart

rewriteObjects

@Named(value="Object:rewrite")
@POST
@Consumes(value="application/json")
@Path(value="/storage/v1/b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}")
RewriteResponse rewriteObjects(@PathParam(value="destinationBucket")
                                                      String destinationBucket,
                                                      @PathParam(value="destinationObject")@Encoded
                                                      String destinationObject,
                                                      @PathParam(value="sourceBucket")
                                                      String sourceBucket,
                                                      @PathParam(value="sourceObject")@Encoded
                                                      String sourceObject)

Rewrites a source object to a destination object.

Parameters:: destinationBucket - Name of the bucket in which the object to be stored; destinationObject - Name of the new object.; sourceBucket - Name of the bucket in which to find the source object.; sourceObject - Name of the source object.
Returns:: a RewriteResponse

rewriteObjects

@Named(value="Object:rewrite")
@POST
@Consumes(value="application/json")
@Path(value="/storage/v1/b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}")
RewriteResponse rewriteObjects(@PathParam(value="destinationBucket")
                                                      String destinationBucket,
                                                      @PathParam(value="destinationObject")@Encoded
                                                      String destinationObject,
                                                      @PathParam(value="sourceBucket")
                                                      String sourceBucket,
                                                      @PathParam(value="sourceObject")@Encoded
                                                      String sourceObject,
                                                      RewriteObjectOptions options)

Rewrites a source object to a destination object.

Parameters:: destinationBucket - Name of the bucket in which the object to be stored; destinationObject - Name of the new object.; sourceBucket - Name of the bucket in which to find the source object.; sourceObject - Name of the source object.; options - Supply an RewriteObjectOptions
Returns:: a RewriteResponse

Interface ObjectApi

Method Summary

Method Detail

objectExists

getObject

getObject

download

download

simpleUpload

deleteObject

deleteObject

listObjects

listObjects

updateObject

updateObject

patchObject

patchObject

composeObjects

composeObjects

copyObject

copyObject

copyObject

multipartUpload

rewriteObjects

rewriteObjects