Viam SDK
    Preparing search index...

    Interface GetSequenceDatasetExportResponse

    GetSequenceDatasetExportResponse reports the current status of an export job. download_url and expires_at are set only when status is COMPLETED; error_message is set only when status is FAILED.

    from message viam.app.dataset.v1.GetSequenceDatasetExportResponse

    interface GetSequenceDatasetExportResponse {
        completedAt?: Timestamp;
        createdAt?: Timestamp;
        downloadUrl: string;
        errorMessage: string;
        expiresAt?: Timestamp;
        jobId: string;
        status: SequenceDatasetExportStatus;
        clone(): GetSequenceDatasetExportResponse;
        equals(
            other:
                | GetSequenceDatasetExportResponse
                | PlainMessage<GetSequenceDatasetExportResponse>
                | null
                | undefined,
        ): boolean;
        fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this;
        fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): this;
        fromJsonString(
            jsonString: string,
            options?: Partial<JsonReadOptions>,
        ): this;
        getType(): MessageType<GetSequenceDatasetExportResponse>;
        toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array;
        toJson(options?: Partial<JsonWriteOptions>): JsonValue;
        toJSON(): JsonValue;
        toJsonString(options?: Partial<JsonWriteStringOptions>): string;
    }

    Hierarchy

    Index

    Properties

    completedAt? createdAt? downloadUrl errorMessage expiresAt? jobId status

    Methods

    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString

    Properties

    completedAt?: Timestamp

    from field: google.protobuf.Timestamp completed_at = 7;

    createdAt?: Timestamp

    from field: google.protobuf.Timestamp created_at = 6;

    downloadUrl: string

    Short-lived (e.g. 1h) signed URL for direct download from backing storage. Empty unless status is COMPLETED.

    from field: string download_url = 3;

    errorMessage: string

    Human-readable cause; empty unless status is FAILED.

    from field: string error_message = 5;

    expiresAt?: Timestamp

    When download_url stops working. Empty unless status is COMPLETED.

    from field: google.protobuf.Timestamp expires_at = 4;

    jobId: string

    from field: string job_id = 1;

    status: SequenceDatasetExportStatus

    from field: viam.app.dataset.v1.SequenceDatasetExportStatus status = 2;

    Methods

    • 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
      • Optionaloptions: Partial<BinaryReadOptions>

      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

    • 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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods