Member Junction
    Preparing search index...

    Class GetMetadataAction

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

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    AuthorizesCaller

    Methods

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

    Constructors

    Properties

    AuthorizesCaller: boolean

    True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

    The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

    Methods

    • Get metadata for a storage object

      Parameters

      • params: RunActionParams

        The action parameters:

        • StorageAccount: 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)

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods