%Net.Cloud.Storage.AmazonS3Client
class %Net.Cloud.Storage.AmazonS3Client extends %Net.Cloud.Storage.Client
Method Inventory
- CreateAcl()
- CreateBucketWithAcl()
- GetBucketAcl()
- GetObjectAcl()
- GetObjectMetadata()
- GetS3AccountId()
- GrantCanonicalPermission()
- GrantEmailPermission()
- PutObjectFromFile()
- PutObjectFromStream()
- PutObjectFromString()
- SetBucketAcl()
- SetObjectAcl()
Methods
method CreateAcl(ownerId As %String = "", ownerDisplayName As %String = "") as %Net.Remote.Object
Create an S3 AccessControlList object from scratch
Create a bucket with default canned ACL that the bucket owner is granted full control
- bucketName: Bucket name
- region: Region name
method GetBucketAcl(bucketName As %String) as %Net.Remote.Object
Get bucket access control list
- bucketName: Bucket name
method GetObjectAcl(bucketName As %String, keyName As %String) as %Net.Remote.Object
Get object access control list
- bucketName: Bucket name
- keyName: Object key name
Get object metadata
- bucketName: Bucket name
- keyName: Object key name
method GetS3AccountId() as %String
Get AWS S3 account id
method GrantCanonicalPermission(acl As %Net.Remote.Object, id As %String, permission As %String)
Possible permission values: FullControl, Read, ReadAcp, Write, WriteAcp
method GrantEmailPermission(acl As %Net.Remote.Object, email As %String, permission As %String)
Possible permission values: FullControl, Read, ReadAcp, Write, WriteAcp
method PutObjectFromFile(bucketName As %String, keyName As %String, filePath As %String, customHeaders As %ArrayOfDataTypes = "", sse As %Boolean = 1, acl As %String = "") as %String
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
method PutObjectFromStream(bucketName As %String, keyName As %String, stream As %Stream.Object, customHeaders As %ArrayOfDataTypes = "", sse As %Boolean = 1, acl As %String = "") as %String
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
method PutObjectFromString(bucketName As %String, keyName As %String, content As %String, customHeaders As %ArrayOfDataTypes = "", sse As %Boolean = 1, acl As %String = "") as %String
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
method SetBucketAcl(bucketName As %String, acl As %Net.Remote.Object) as %Net.Remote.Object
Set bucket access control list
- bucketName: Bucket name
- acl: acl Java object
method SetObjectAcl(bucketName As %String, keyName As %String, acl As %Net.Remote.Object) as %Net.Remote.Object
Set object access control list
- bucketName: Bucket name
- keyName: Object key name
- acl: ACL Java object
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- BlobExists()
- BucketExists()
- Close()
- CreateBucket()
- CreateClient()
- DeleteBlob()
- DeleteBucket()
- DownloadBlobToFile()
- DownloadBlobToStream()
- DownloadBlobToString()
- GetBlobInfo()
- GetBucketInfo()
- IsBucketPublicAccessible()
- ListBlobs()
- ListBuckets()
- SingleDownloadBlobToFile()
- SingleDownloadBlobToStream()
- SingleDownloadBlobToString()
- SingleUploadBlobFromFile()
- SingleUploadBlobFromStream()
- SingleUploadBlobFromString()
- UploadBlobFromFile()
- UploadBlobFromStream()
- UploadBlobFromString()