Class GetMetadataAction

Action for retrieving metadata about a file object in a storage provider.

Example

await runAction({
  ActionName: 'Get Storage Object Metadata',
  Params: [{
    Name: 'StorageProvider',
    Value: 'AWS S3 Storage'
  }, {
    Name: 'ObjectName',
    Value: 'reports/annual-report.pdf'
  }]
});

Hierarchy (view full)

Constructors

constructor

Methods

InternalRunAction Run addOutputParam createErrorResult createSuccessResult getBooleanParam getDriverFromParams getNumericParam getParamValue getStorageProvider getStringParam getStringParamWithDefault initializeDriver

Constructors

constructor

Methods

Protected InternalRunAction

  • InternalRunAction(params): Promise<ActionResultSimple>

  • Get metadata for a storage object

    Parameters

    • params: RunActionParams<any>

      The action parameters:

      • StorageProvider: Required - Name of the storage provider
      • ObjectName: Required if ObjectID not provided - Name/path of the object
      • ObjectID: Optional - Provider-specific object ID (bypasses path resolution for faster access)

    Returns Promise<ActionResultSimple>

    Operation result with metadata fields:

    • Name: File name
    • Path: Directory path
    • FullPath: Complete path
    • Size: File size in bytes
    • ContentType: MIME type
    • LastModified: Last modified timestamp
    • IsDirectory: Whether object is a directory
    • ETag: Entity tag (if available)
    • CustomMetadata: Custom metadata key-value pairs (if available)

Run

Protected addOutputParam

Protected createErrorResult

Protected createSuccessResult

Protected getBooleanParam

Protected getDriverFromParams

Protected getNumericParam

Protected getParamValue

Protected getStorageProvider

Protected getStringParam

Protected getStringParamWithDefault

Protected initializeDriver

Settings

Member Visibility

Theme

On This Page

constructorInternalRunActionRunaddOutputParamcreateErrorResultcreateSuccessResultgetBooleanParamgetDriverFromParamsgetNumericParamgetParamValuegetStorageProvidergetStringParamgetStringParamWithDefaultinitializeDriver