Viam SDK
    Preparing search index...

    Class RegistryItemBilling

    RegistryItemBilling stores usage cost information for a registry item. Its shape mirrors the billing block used by fragments so that billing jobs can consume registry item costs the same way. For now only cost_per_month.per_machine is supported; the additional fields that fragment billing supports (cost_per_year, tier_name, in_arrears, etc.) are intentionally omitted.

    from message viam.app.v1.RegistryItemBilling

    Hierarchy

    Index

    Constructors

    Properties

    frequency:
        | { case: "costPerMonth"; value: RegistryItemCostByResource }
        | { case: "costPerYear"; value: RegistryItemCostByResource }
        | { case: undefined; value?: undefined }

    Type Declaration

    • { case: "costPerMonth"; value: RegistryItemCostByResource }
      • case: "costPerMonth"
      • value: RegistryItemCostByResource

        The recurring monthly cost of the item, broken down by billable resource.

        from field: viam.app.v1.RegistryItemCostByResource cost_per_month = 1;

    • { case: "costPerYear"; value: RegistryItemCostByResource }
      • case: "costPerYear"
      • value: RegistryItemCostByResource

        The recurring yearly cost of the item, broken down by billable resource.

        from field: viam.app.v1.RegistryItemCostByResource cost_per_year = 2;

    • { case: undefined; value?: undefined }

    from oneof viam.app.v1.RegistryItemBilling.frequency

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.app.v1.RegistryItemBilling"

    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<RegistryItemBilling>

    • 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

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns RegistryItemBilling

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns RegistryItemBilling