Class ListRegistryItemsRequest

Generated

from message viam.app.v1.ListRegistryItemsRequest

Hierarchy

Constructors

Properties

organizationId?: string

The id of the organization to return registry items for.

Generated

from field: optional string organization_id = 1;

pageToken?: string

Generated

from field: optional string page_token = 7;

platforms: string[]

Generated

from field: repeated string platforms = 4;

publicNamespaces: string[]

One or more public namespaces to return results for.

Generated

from field: repeated string public_namespaces = 8;

searchTerm?: string

Generated

from field: optional string search_term = 6;

statuses: RegistryItemStatus[]

Generated

from field: repeated viam.app.v1.RegistryItemStatus statuses = 5;

types: PackageType[]

Generated

from field: repeated viam.app.packages.v1.PackageType types = 2;

visibilities: Visibility[]

Generated

from field: repeated viam.app.v1.Visibility visibilities = 3;

fields: FieldList
runtime: ProtoRuntime
typeName: "viam.app.v1.ListRegistryItemsRequest" = "viam.app.v1.ListRegistryItemsRequest"

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
    • 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<ListRegistryItemsRequest>

  • 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

Generated using TypeDoc