Jobs AddMetadata RPC

0.8.1

Requests the addition of metadata to a job.

rpc AddMetadata (JobsAddMetadataRequest) returns (JobsAddMetadataResponse)

Messages

  • JobsAddMetadataRequest

  • JobsAddMetadataResponse

Copy
Copied!
            

message JobsAddMetadataRequest { ResponseHeader header = 1; Identifier job_id = 2; map<string, string> metadata = 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 appended.

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.

metadata

type: map

Set of key/value pairs to be appended to the job metadata.

Key and value are string types.

If a metadata key in the request already exists in the job record, or if duplicate keys are passed in the request, the job will not be updated and and an error will be returned.

Keys are compared using case insensitive comparator functions.

The maximum allowed size of a metadata key is 128 bytes, while the maximum allowed size of a metadata value is 256 bytes.

The maximum allowed size for the overall metadata of an individual job is 4 Megabytes.

Copy
Copied!
            

message JobAddMetadataResponse { 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 JobsAddMetadataResponse 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 to be appended.

See Identifier for details.

metadata

type: map

Metadata (set of all key/value pairs) of the job after adding the metadata in the job record.

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