@audiotool/nexus - v0.0.12
    Preparing search index...

    Class OperationGenerated

    This resource represents a long-running operation that is the result of a network API call.

    from message audiotool.longrunning.v1.Operation

    Hierarchy

    Index

    Constructors

    Properties

    createTime?: Timestamp

    The time the operation was created.

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

    done: boolean = false

    If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

    from field: bool done = 3;

    metadata?: Any

    Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

    from field: google.protobuf.Any metadata = 2;

    name: string = ""

    The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

    from field: string name = 1;

    owners: string[] = []

    List of owners for this Operation

    from field: repeated string owners = 6;

    result:
        | { case: "error"; value: Status }
        | { case: "response"; value: Any }
        | { case: undefined; value?: undefined } = ...

    The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response is set.

    from oneof audiotool.longrunning.v1.Operation.result

    Type declaration

    • { case: "error"; value: Status }
      • case: "error"
      • Generatedvalue: Status

        The error result of the operation in case of failure or cancellation.

        from field: audiotool.longrunning.v1.Status error = 4;

    • { case: "response"; value: Any }
      • case: "response"
      • Generatedvalue: Any

        The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

        from field: google.protobuf.Any response = 5;

    • { case: undefined; value?: undefined }
    fields: FieldList = ...
    runtime: ProtoRuntime = proto3
    typeName: "audiotool.longrunning.v1.Operation"

    Methods

    • Create a deep copy.

      Returns Operation

    • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

      Parameters

      Returns boolean

    • 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

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

    • 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