Class ResourceStatus

Generated

from message viam.robot.v1.ResourceStatus

Hierarchy

Constructors

constructor

Properties

cloudMetadata? error lastUpdated? name? revision state fields runtime typeName

Methods

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

Constructors

constructor

Properties

OptionalcloudMetadata

cloudMetadata?: GetCloudMetadataResponse

infomation about resource orgID, locationID and partID

Generated

from field: optional viam.robot.v1.GetCloudMetadataResponse cloud_metadata = 6;

error

error: string

error details for a resource. This is guaranteed to be null if the resource is ready and non-null if the resource unhealthy.

Generated

from field: string error = 5;

OptionallastUpdated

lastUpdated?: Timestamp

state transition timestamp.

Generated

from field: google.protobuf.Timestamp last_updated = 3;

Optionalname

name?: commonApi.ResourceName

resource name.

Generated

from field: viam.common.v1.ResourceName name = 1;

revision

revision: string

revision of the last config that successfully updated this resource.

Generated

from field: string revision = 4;

state

state: ResourceStatus_State

current state.

Generated

from field: viam.robot.v1.ResourceStatus.State state = 2;

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "viam.robot.v1.ResourceStatus"

Methods

clone

equals

fromBinary

  • fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this

    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

fromJson

  • fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

fromJsonString

  • fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

getType

  • getType(): MessageType<ResourceStatus>

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

    Returns MessageType<ResourceStatus>

toBinary

  • toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array

    Serialize the message to binary data.

    Parameters

    • Optionaloptions: Partial<BinaryWriteOptions>

    Returns Uint8Array

toJson

  • toJson(options?: Partial<JsonWriteOptions>): JsonValue

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

    Parameters

    • Optionaloptions: Partial<JsonWriteOptions>

    Returns JsonValue

ProtectedtoJSON

  • toJSON(): 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

toJsonString

  • toJsonString(options?: Partial<JsonWriteStringOptions>): string

    Serialize the message to a JSON string.

    Parameters

    • Optionaloptions: Partial<JsonWriteStringOptions>

    Returns string

Staticequals

StaticfromBinary

  • fromBinary(
        bytes: Uint8Array,
        options?: Partial<BinaryReadOptions>,
    ): ResourceStatus

    Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns ResourceStatus

StaticfromJson

StaticfromJsonString

  • fromJsonString(
        jsonString: string,
        options?: Partial<JsonReadOptions>,
    ): ResourceStatus

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns ResourceStatus

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR