cdx-proto
    Preparing search index...

    Type Alias Workspace

    Workspace: Message<"cyclonedx.v1_5.Workspace"> & {
        accessMode?: cdx_15.Workspace_AccessMode;
        aliases: string[];
        bomRef: string;
        description?: string;
        managedDataType?: string;
        mountPath?: string;
        name?: string;
        properties: cdx_15.Property[];
        resourceReferences: cdx_15.ResourceReferenceChoice[];
        uid: string;
        volume?: cdx_15.Volume;
        volumeRequest?: string;
    }

    A named filesystem or data resource shareable by workflow tasks.

    Type declaration

    • OptionalaccessMode?: cdx_15.Workspace_AccessMode

      Describes the read-write access control for the workspace relative to the owning resource instance.

      from field: optional cyclonedx.v1_5.Workspace.AccessMode accessMode = 8;

    • aliases: string[]

      The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps.

      from field: repeated string aliases = 4;

    • bomRef: string

      BOM unique reference to the resource.

      from field: string bom_ref = 1;

    • Optionaldescription?: string

      A description of the resource instance.

      from field: optional string description = 5;

    • OptionalmanagedDataType?: string

      The name of a domain-specific data type the workspace represents.

      from field: optional string managedDataType = 10;

    • OptionalmountPath?: string

      A path to a location on disk where the workspace will be available to the associated task's steps.

      from field: optional string mountPath = 9;

    • Optionalname?: string

      The name of the resource instance.

      from field: optional string name = 3;

    • properties: cdx_15.Property[]

      Domain-specific workspace instance properties.

      from field: repeated cyclonedx.v1_5.Property properties = 6;

    • resourceReferences: cdx_15.ResourceReferenceChoice[]

      References to component or service resources that are used to realize the resource instance.

      from field: repeated cyclonedx.v1_5.ResourceReferenceChoice resourceReferences = 7;

    • uid: string

      The unique identifier for the resource instance within its deployment context.

      from field: string uid = 2;

    • Optionalvolume?: cdx_15.Volume

      Information about the actual volume instance allocated to the workspace.

      from field: optional cyclonedx.v1_5.Volume volume = 12;

    • OptionalvolumeRequest?: string

      Identifies the reference to the request for a specific volume type and parameters.

      from field: optional string volumeRequest = 11;

    from message cyclonedx.v1_5.Workspace

    Settings

    Member Visibility