AmazonS3Client Class Reference

Inheritance diagram for AmazonS3Client:

Collaboration diagram for AmazonS3Client:

Public Member Functions
_.Net.Remote.Object	CreateAcl (_.Library.String ownerId, _.Library.String ownerDisplayName)
	Create an S3 AccessControlList object from scratch.
	CreateBucketWithAcl (_.Library.String bucketName, _.Library.String region)
	Create a bucket with default canned ACL that the bucket owner is granted full control. More...
_.Net.Remote.Object	GetBucketAcl (_.Library.String bucketName)
	Get bucket access control list. More...
_.Net.Remote.Object	GetObjectAcl (_.Library.String bucketName, _.Library.String keyName)
	Get object access control list. More...
_.Library.String	GetObjectMetadata (_.Library.String bucketName, _.Library.String keyName)
	Get object metadata. More...
_.Library.String	GetS3AccountId ()
	Get AWS S3 account id.
	GrantCanonicalPermission (_.Net.Remote.Object acl, _.Library.String id, _.Library.String permission)
	Possible permission values: FullControl, Read, ReadAcp, Write, WriteAcp.
	GrantEmailPermission (_.Net.Remote.Object acl, _.Library.String email, _.Library.String permission)
	Possible permission values: FullControl, Read, ReadAcp, Write, WriteAcp.
_.Library.String	PutObjectFromFile (_.Library.String bucketName, _.Library.String keyName, _.Library.String filePath, _.Library.ArrayOfDataTypes customHeaders, _.Library.Boolean sse, _.Library.String acl)
	Upload a File object to the cloud. More...
_.Library.String	PutObjectFromStream (_.Library.String bucketName, _.Library.String keyName, _.Stream.Object stream, _.Library.ArrayOfDataTypes customHeaders, _.Library.Boolean sse, _.Library.String acl)
	Upload IRIS binary or character stream object to the cloud. More...
_.Library.String	PutObjectFromString (_.Library.String bucketName, _.Library.String keyName, _.Library.String content, _.Library.ArrayOfDataTypes customHeaders, _.Library.Boolean sse, _.Library.String acl)
	Upload a String object to the cloud. More...
_.Net.Remote.Object	SetBucketAcl (_.Library.String bucketName, _.Net.Remote.Object acl)
	Set bucket access control list. More...
_.Net.Remote.Object	SetObjectAcl (_.Library.String bucketName, _.Library.String keyName, _.Net.Remote.Object acl)
	Set object access control list. More...
Public Member Functions inherited from Client
_.Library.Boolean	BlobExists (_.Library.String bucketName, _.Library.String blobName)
	Test if a blob exists.
_.Library.Boolean	BucketExists (_.Library.String bucketName)
	Test if a bucket exists.
	Close ()
	Close storage client and disconnect Java gateway.
	CreateBucket (_.Library.String bucketName)
	Create a new bucket.
	DeleteBlob (_.Library.String bucketName, _.Library.String blobName)
	Delete a blob from the cloud.
	DeleteBucket (_.Library.String bucketName)
	Delete a bucket from the cloud.
	DownloadBlobToFile (_.Library.String bucketName, _.Library.String blobName, _.Library.String filePath)
	Download a blob from the cloud to a file.
_.Stream.Object	DownloadBlobToStream (_.Library.String bucketName, _.Library.String blobName, _.Library.String blobEncoding)
	Download a blob from the cloud to a stream. More...
_.Library.String	DownloadBlobToString (_.Library.String bucketName, _.Library.String blobName, _.Library.String blobEncoding)
	Download a blob from the cloud to a string. More...
_.Net.Cloud.Storage.BlobInfo	GetBlobInfo (_.Library.String bucketName, _.Library.String blobName)
	Get blob info.
_.Net.Cloud.Storage.BucketInfo	GetBucketInfo (_.Library.String bucketName)
	Get bucket info.
_.Library.Boolean	IsBucketPublicAccessible (_.Library.String bucketName)
	Test if a bucket is public accessible.
_.Library.ListOfObjects	ListBlobs (_.Library.String bucketName, _.Library.String blobNamePrefix, _.Library.String blobNamePattern)
	List all blobs within a bucket, filtered by blobNamePrefix and blobNamePattern. More...
_.Library.ListOfObjects	ListBuckets ()
	List all buckets.
	UploadBlobFromFile (_.Library.String bucketName, _.Library.String blobName, _.Library.String filePath)
	Upload a file blob to the cloud.
	UploadBlobFromStream (_.Library.String bucketName, _.Library.String blobName, _.Stream.Object stream)
	Upload a binary or character stream blob to the cloud. More...
	UploadBlobFromString (_.Library.String bucketName, _.Library.String blobName, _.Library.String content)
	Upload a string blob to the cloud. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Additional Inherited Members
Static Public Member Functions inherited from Client
_.Net.Cloud.Storage.Client	CreateClient (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.Status sc, _.Library.String endPoint)
	Factory method to create a cloud storage client. More...
_.Library.Status	SingleDownloadBlobToFile (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String filePath)
	Single method to download blob to file.
_.Library.Status	SingleDownloadBlobToStream (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String blobEncoding, _.Stream.Object toStream)
	Single method to download blob to stream.
_.Library.Status	SingleDownloadBlobToString (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String blobEncoding, _.Library.String toString)
	Single method to download blob to string.
_.Library.Status	SingleUploadBlobFromFile (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String filePath)
	Single method to upload blob from file.
_.Library.Status	SingleUploadBlobFromStream (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Stream.Object stream)
	Single method to upload blob from stream.
_.Library.Status	SingleUploadBlobFromString (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String content)
	Single method to upload blob from string.
Public Attributes inherited from Client
	gateway
	Connection to a Java Gateway. More...
	jclient
	Remote Java client object to Azure, Google or S3. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Member Function Documentation

CreateBucketWithAcl()

CreateBucketWithAcl	(	_.Library.String	bucketName,
		_.Library.String	region
	)

Create a bucket with default canned ACL that the bucket owner is granted full control.

• bucketName: Bucket name
• region: Region name

GetBucketAcl()

_.Net.Remote.Object GetBucketAcl

(

_.Library.String

bucketName

)

Get bucket access control list.

• bucketName: Bucket name

Return ACL ACL Java object

GetObjectAcl()

_.Net.Remote.Object GetObjectAcl	(	_.Library.String	bucketName,
		_.Library.String	keyName
	)

Get object access control list.

• bucketName: Bucket name
• keyName: Object key name

Return an ACL Java object

GetObjectMetadata()

_.Library.String GetObjectMetadata	(	_.Library.String	bucketName,
		_.Library.String	keyName
	)

Get object metadata.

• bucketName: Bucket name
• keyName: Object key name

Return json representation of ObjectMetadata

PutObjectFromFile()

_.Library.String PutObjectFromFile	(	_.Library.String	bucketName,
		_.Library.String	keyName,
		_.Library.String	filePath,
		_.Library.ArrayOfDataTypes	customHeaders,
		_.Library.Boolean	sse,
		_.Library.String	acl
	)

Upload a File object to the cloud.

• bucketName: Bucket name
• keyName: Object key name
• filePath: File name with path
• customHeaders: Custom header name value pairs
• sse: Server side encryption flag
• acl: Canned ACL value. Possible values: AuthenticatedRead, AwsExecRead, BucketOwnerFullControl, BucketOwnerRead, LogDeliveryWrite, Private, PublicRead, PublicReadWrite

Return json representation of S3 PutObjectResult

PutObjectFromStream()

_.Library.String PutObjectFromStream	(	_.Library.String	bucketName,
		_.Library.String	keyName,
		_.Stream.Object	stream,
		_.Library.ArrayOfDataTypes	customHeaders,
		_.Library.Boolean	sse,
		_.Library.String	acl
	)

Upload IRIS binary or character stream object to the cloud.

• bucketName: Bucket name
• keyName: Object key name
• stream: IRIS stream object to be uploaded. A character stream will be converted to a binary stream with UTF-8 encoding.
• customHeaders: Custom header name value pairs
• sse: Server side encryption flag
• acl: Canned ACL value. Possible values: AuthenticatedRead, AwsExecRead, BucketOwnerFullControl, BucketOwnerRead, LogDeliveryWrite, Private, PublicRead, PublicReadWrite

Return json representation of S3 PutObjectResult

PutObjectFromString()

_.Library.String PutObjectFromString	(	_.Library.String	bucketName,
		_.Library.String	keyName,
		_.Library.String	content,
		_.Library.ArrayOfDataTypes	customHeaders,
		_.Library.Boolean	sse,
		_.Library.String	acl
	)

Upload a String object to the cloud.

• bucketName: Bucket name
• keyName: Object key name
• content: String content of the object
• customHeaders: Custom header name value pairs
• sse: Server side encryption flag
• acl: Canned ACL value. Possible values: AuthenticatedRead, AwsExecRead, BucketOwnerFullControl, BucketOwnerRead, LogDeliveryWrite, Private, PublicRead, PublicReadWrite

Return json representation of S3 PutObjectResult

SetBucketAcl()

_.Net.Remote.Object SetBucketAcl	(	_.Library.String	bucketName,
		_.Net.Remote.Object	acl
	)

Set bucket access control list.

• bucketName: Bucket name
• acl: acl Java object

SetObjectAcl()

_.Net.Remote.Object SetObjectAcl	(	_.Library.String	bucketName,
		_.Library.String	keyName,
		_.Net.Remote.Object	acl
	)

Set object access control list.

• bucketName: Bucket name
• keyName: Object key name
• acl: ACL Java object