An identifiable, logical unit of data storage tied to a physical device.

Generated

from message cyclonedx.v1_6.Volume

Hierarchy

Constructors

Properties

The volume mode for the volume instance.

Generated

from field: optional cyclonedx.v1_6.Volume.VolumeMode mode = 3;

name?: string

The name of the volume instance

Generated

from field: optional string name = 2;

path?: string

The underlying path created from the actual volume.

Generated

from field: optional string path = 4;

persistent?: boolean

Indicates if the volume persists beyond the life of the resource it is associated with.

Generated

from field: optional bool persistent = 6;

properties: cdx_16.Property[] = []

Domain-specific volume instance properties.

Generated

from field: repeated cyclonedx.v1_6.Property properties = 8;

remote?: boolean

Indicates if the volume is remotely (i.e., network) attached.

Generated

from field: optional bool remote = 7;

sizeAllocated?: string

The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as the IEC standard unit in either decimal or binary form.

Generated

from field: optional string sizeAllocated = 5;

uid?: string

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

Generated

from field: optional string uid = 1;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cyclonedx.v1_6.Volume" = "cyclonedx.v1_6.Volume"

Methods

  • Create a deep copy.

    Returns cdx_16.Volume

  • 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_16.Volume>

  • 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