EnsLib.CloudStorage.InboundAdapter
class EnsLib.CloudStorage.InboundAdapter extends EnsLib.CloudStorage.Common, Ens.InboundAdapter
Property Inventory
- AppendTimestamp
- ArchiveBucket
- ArchiveFolder
- BlobNamePattern
- BlobNamePrefix
- BucketName
- DeleteAfterDownload
- ErrorBucket
- ErrorFolder
- SubdirectoryLevels
Method Inventory
Parameters
parameter SETTINGS = BucketName:Cloud Storage,BlobNamePrefix:Cloud Storage,BlobNamePattern:Cloud Storage,SubdirectoryLevels: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.
If the prefix is a folder, end it with /.
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()
property SubdirectoryLevels as %Integer (MINVAL = -1) [ InitialExpression = -1 ];
Number of levels of subdirectory depth under the BlobNamePrefix that should be searched for files matching the BlobNamePattern.
Use -1 to search all subdirectory levels.
Use -1 to search all subdirectory levels.
Property methods: SubdirectoryLevelsDisplayToLogical(), SubdirectoryLevelsGet(), SubdirectoryLevelsIsValid(), SubdirectoryLevelsLogicalToDisplay(), SubdirectoryLevelsNormalize(), SubdirectoryLevelsSet()
Methods
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()
method OnTask() as %Status
Inherited description: default InboundAdapter behavior: always call ProcessInput on CallInterval
Inherited Members
Inherited Properties
- %CredentialsObj
- %WarnedLatest
- BusinessHost
- CallInterval
- Credentials
- EndPoint
- JavaServer
- KeepaliveInterval
- ProviderCredentialsFile
- RegistryID
- StorageProvider
- StorageRegion
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()
- AssignOneSetting()
- CheckGatewayConnection()
- ClearAllAppData()
- ClearRuntimeAppData()
- ClearStaticAppData()
- Connect()
- CredentialsSet()
- Disconnect()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- GetSettings()
- OnKeepalive()
- OnTearDown()