Jobs RemoveMetadata RPC

0.8.1

Requests the removal of metadata from a job.

rpc RemoveMetadata (JobsRemoveMetadataRequest) returns (JobsRemoveMetadataResponse)

Messages

  • JobsRemoveMetadataRequest

  • JobsRemoveMetadataResponse

Copy
Copied!
            

message JobsRemoveMetadataRequest { ResponseHeader header = 1; Identifier job_id = 2; repeated string keys = 3;; }


Properties

type: message

Standard RPC request header.

See RequestHeader for details.

job_id

type: message

Unique identifier of the job whose metadata is to be updated.

Required. If the identifier value is omitted from the request or does not match any known job identifier, Clara Deploy SDK will be unable to fulfill the request.

See Identifier for details.

keys

type: repeated string

List of keys to be removed from the job metadata.

Key is a string type.

Copy
Copied!
            

message JobRemoveMetadataResponse { ResponseHeader header = 1; Identifier job_id = 2; map<string, string> metadata = 3; }


Clara Deploy SDK Jobs service will respond to any add metadata request with a JobsRemoveMetadataResponse message. Requestors can use the response message to determine the result of their request.

Properties

header

type: message

Standard RPC response header.

See ResponseHeader for details.

job_id

type: message

Unique identifier of the job whose metadata is updated.

See Identifier for details.

metadata

type: map

Metadata (set of all key/value pairs) of the job after removing the specified keys from the job record.

© Copyright 2018-2020, NVIDIA Corporation. All rights reserved.. Last updated on Feb 1, 2023.