A named filesystem or data resource shareable by workflow tasks.

Generated

from message cyclonedx.v1_5.Workspace

Hierarchy

Constructors

Properties

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

Generated

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.

Generated

from field: repeated string aliases = 4;

bomRef: string = ""

BOM unique reference to the resource.

Generated

from field: string bom_ref = 1;

description?: string

A description of the resource instance.

Generated

from field: optional string description = 5;

managedDataType?: string

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

Generated

from field: optional string managedDataType = 10;

mountPath?: string

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

Generated

from field: optional string mountPath = 9;

name?: string

The name of the resource instance.

Generated

from field: optional string name = 3;

properties: cdx_15.Property[] = []

Domain-specific workspace instance properties.

Generated

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.

Generated

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

uid: string = ""

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

Generated

from field: string uid = 2;

volume?: cdx_15.Volume

Information about the actual volume instance allocated to the workspace.

Generated

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

volumeRequest?: string

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

Generated

from field: optional string volumeRequest = 11;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cyclonedx.v1_5.Workspace" = "cyclonedx.v1_5.Workspace"

Methods

  • Create a deep copy.

    Returns cdx_15.Workspace

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<cdx_15.Workspace>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string