Skip to main content

EnsLib.CloudStorage.InboundAdapter

class EnsLib.CloudStorage.InboundAdapter extends EnsLib.CloudStorage.Common, EnsLib.PEX.InboundAdapter

Property Inventory

Method Inventory

Parameters

parameter SETTINGS = BucketName:Cloud Storage,BlobNamePrefix:Cloud Storage,BlobNamePattern:Cloud Storage,DeleteAfterDownload:Cloud Storage,AppendTimestamp:Cloud Storage,ArchiveBucket:Cloud Storage,ArchiveFolder:Cloud Storage,ErrorBucket:Cloud Storage,ErrorFolder:Cloud Storage;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property AppendTimestamp as %Boolean [ InitialExpression = 0 ];
Flag to indicate whether appending a timestamp when archiving a blob
Property methods: AppendTimestampDisplayToLogical(), AppendTimestampGet(), AppendTimestampIsValid(), AppendTimestampLogicalToDisplay(), AppendTimestampNormalize(), AppendTimestampSet()
property ArchiveBucket as %String (MAXLEN = 1000);
Archive bucket name
Property methods: ArchiveBucketDisplayToLogical(), ArchiveBucketGet(), ArchiveBucketIsValid(), ArchiveBucketLogicalToDisplay(), ArchiveBucketLogicalToOdbc(), ArchiveBucketNormalize(), ArchiveBucketSet()
property ArchiveFolder as %String (MAXLEN = 1000);
Archive folder name
Property methods: ArchiveFolderDisplayToLogical(), ArchiveFolderGet(), ArchiveFolderIsValid(), ArchiveFolderLogicalToDisplay(), ArchiveFolderLogicalToOdbc(), ArchiveFolderNormalize(), ArchiveFolderSet()
property BlobNamePattern as %String (MAXLEN = 1000);
Blob name pattern, used to filter blobs on client. Support wildcards ? and *.
Property methods: BlobNamePatternDisplayToLogical(), BlobNamePatternGet(), BlobNamePatternIsValid(), BlobNamePatternLogicalToDisplay(), BlobNamePatternLogicalToOdbc(), BlobNamePatternNormalize(), BlobNamePatternSet()
property BlobNamePrefix as %String (MAXLEN = 1000);
Blob name prefix, used to filter blobs on server.
Property methods: BlobNamePrefixDisplayToLogical(), BlobNamePrefixGet(), BlobNamePrefixIsValid(), BlobNamePrefixLogicalToDisplay(), BlobNamePrefixLogicalToOdbc(), BlobNamePrefixNormalize(), BlobNamePrefixSet()
property BucketName as %String (MAXLEN = 1000);
Bucket name
Property methods: BucketNameDisplayToLogical(), BucketNameGet(), BucketNameIsValid(), BucketNameLogicalToDisplay(), BucketNameLogicalToOdbc(), BucketNameNormalize(), BucketNameSet()
property DeleteAfterDownload as %Boolean [ InitialExpression = 1 ];
Flag to indicate whether deleting the blob after downlaod
Property methods: DeleteAfterDownloadDisplayToLogical(), DeleteAfterDownloadGet(), DeleteAfterDownloadIsValid(), DeleteAfterDownloadLogicalToDisplay(), DeleteAfterDownloadNormalize(), DeleteAfterDownloadSet()
property ErrorBucket as %String (MAXLEN = 1000);
Error archive bucket name
Property methods: ErrorBucketDisplayToLogical(), ErrorBucketGet(), ErrorBucketIsValid(), ErrorBucketLogicalToDisplay(), ErrorBucketLogicalToOdbc(), ErrorBucketNormalize(), ErrorBucketSet()
property ErrorFolder as %String (MAXLEN = 1000);
Error archive folder name
Property methods: ErrorFolderDisplayToLogical(), ErrorFolderGet(), ErrorFolderIsValid(), ErrorFolderLogicalToDisplay(), ErrorFolderLogicalToOdbc(), ErrorFolderNormalize(), ErrorFolderSet()

Methods

method CreateInboundInput(pInput As %Net.Remote.Object) as InboundInput
method IsProcessed(BucketName As %String, BlobName As %String) as %Boolean
Test if a blob has been processed
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()
method SetProcessed(BucketName As %String, BlobName As %String, Value As %String)
Set global to indicate a blob is processed

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab