Viam SDK
    Preparing search index...

    Class DeleteTabularDataRequest

    DeleteTabularDataRequest deletes the data from the organization that is older than delete_older_than_days in UTC time. For example, if delete_older_than_days=1 and the request is made at 1AM EST on March 11 (March 11 5AM UTC), this deletes all data captured through March 10 11:59:59PM UTC. If the request is at 10PM EST on March 11 (March 12 2AM UTC), this deletes all data captured through March 11 11:59:59PM UTC. If delete_older_than_days is 0, all existing data is deleted. If no filter is provided, data will be deleted based on organization_id.

    from message viam.app.data.v1.DeleteTabularDataRequest

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    deleteOlderThanDays filter? organizationId fields runtime typeName

    Methods

    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString

    Constructors

    Properties

    deleteOlderThanDays: number

    from field: uint32 delete_older_than_days = 2;

    filter?: DeleteTabularFilter

    from field: optional viam.app.data.v1.DeleteTabularFilter filter = 3;

    organizationId: string

    from field: string organization_id = 1;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.app.data.v1.DeleteTabularDataRequest"

    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

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

      Returns MessageType<DeleteTabularDataRequest>

    • 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

    Constructors
    Properties
    Methods