@audiotool/nexus - v0.0.17
    Preparing search index...

    Class SampleProcessGenerated

    A sample process is a sample that is being uploaded or processed.

    from message audiotool.sample.v1.SampleProcess

    Hierarchy

    Index

    Constructors

    Properties

    process:
        | { case: "uploadEndpoint"; value: SampleUploadEndpoint }
        | { case: "operation"; value: Operation }
        | { case: undefined; value?: undefined } = ...

    The process of the sample.

    from oneof audiotool.sample.v1.SampleProcess.process

    Type declaration

    • { case: "uploadEndpoint"; value: SampleUploadEndpoint }
      • case: "uploadEndpoint"
      • Generatedvalue: SampleUploadEndpoint

        The upload endpoint for the sample if the upload is not finished.

        from field: audiotool.sample.v1.SampleUploadEndpoint upload_endpoint = 2;

    • { case: "operation"; value: Operation }
      • case: "operation"
      • Generatedvalue: Operation

        The operation for the sample if upload is finished and processing.

        from field: audiotool.longrunning.v1.Operation operation = 3;

    • { case: undefined; value?: undefined }
    sample?: sample.Sample

    The sample that is being uploaded or processed.

    from field: audiotool.sample.v1.Sample sample = 1;

    fields: FieldList = ...
    runtime: ProtoRuntime = proto3
    typeName: "audiotool.sample.v1.SampleProcess"

    Methods

    • Create a deep copy.

      Returns SampleProcess

    • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

      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

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: 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<SampleProcess>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

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

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • 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 string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string