org.jclouds.snia.cdmi.v1.features

Interface DataApi

public interface DataApi

Data Object Resource Operations

Method Summary

Modifier and Type	Method and Description
DataObject	create(String dataObjectName, CreateDataObjectOptions... options) create CDMI Data object
void	delete(String dataObjectName) delete CDMI Data object
DataObject	get(String dataObjectName) get CDMI Data object
DataObject	get(String dataObjectName, DataObjectQueryParams queryParams) get CDMI Data object

Method Detail

get

@GET
 @Consumes(value={"application/cdmi-object","application/json"})
 @Path(value="/{dataObjectName}")
DataObject get(@PathParam(value="dataObjectName")
                                                                                                                       String dataObjectName)

get CDMI Data object

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

Returns:

DataObject

  Examples: 
  
  dataObject = get("myDataObject");
  dataObject = get("parentContainer/childContainer","myDataObject");
 
 
         

get

@GET
 @Consumes(value={"application/cdmi-object","application/json"})
 @Path(value="/{dataObjectName}")
DataObject get(@PathParam(value="dataObjectName")
                                                                                                                       String dataObjectName,
                                                                                                                       DataObjectQueryParams queryParams)

get CDMI Data object

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

queryParams - enables getting only certain fields, metadata, value range

Returns:

DataObject

  Examples: 
  
  dataObject = get("myDataObject",ContainerQueryParams.Builder.field("parentURI").field("objectName"));
  dataObject = get("myDataObject",ContainerQueryParams.Builder.value(0,10));
 
 
         

create

@PUT
 @Consumes(value={"application/cdmi-object","application/json"})
 @Produces(value="application/cdmi-object")
 @Path(value="/{dataObjectName}")
DataObject create(@PathParam(value="dataObjectName")
                                                                                                                                                                      String dataObjectName,
                                                                                                                                                                      CreateDataObjectOptions... options)

create CDMI Data object

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

options - enables defining the body i.e. metadata, mimetype, value

Returns:

DataObject

  Examples: 
  
  dataObject = create(
                                "myDataObject",
                                CreateDataObjectOptions.Builder
                                                    .value(value)
                                                    .mimetype("text/plain")
                                                    .metadata(pDataObjectMetaDataIn);
 
 
         

delete

@DELETE
 @Consumes(value="text/plain")
 @Path(value="/{dataObjectName}")
void delete(@PathParam(value="dataObjectName")
                                                                                     String dataObjectName)

delete CDMI Data object

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

  Examples: 
  
  delete("myDataObject");