Jobmetadata

Class: metadata

The Jobmetadata component is used to define the metadata of an SDK Job. Because SDK Jobs are invoked through their Jobmetadata, every class implemented using the Job interface must be associated to a Jobmetadata component. Note: You may see Vault-supplied SDK jobs which work to deliver various features.

Learn about Administering SDK Job Metadata in Vault Help.

Attribute	Metadata	Description
`label`	Type: String Max length: 60	UI-friendly string in the Vault's base language.
`active`	Type: Boolean	Indicates whether the field is active.
`chunk_size`	Type: Number	Defines the number of Job items to be processed in each task.
`description`	Type: String Max length: 1500	Description of the job which displays in the UI.
`job_code`	Type: ComponentReference Required	References the fully qualified class name of an `Sdkjob` component.
`queue`	Type: ComponentReference	The queue the job will place messages into. Custom jobs cannot reference standard queues.
`single_instance_states`	Type: Enum Multi-value Allowed values: scheduled queued running	Defines a state or states as single instance. Only one instance of a job is allowed to be in a single instance state at any given time.
`timeout_duration`	Type: Number	The maximum number of minutes a job is allowed to run before it times out. If set, this attribute overrides the default timeout, which is 23 hours (1380 minutes) for one-time jobs or 72 hours (4320 minutes) for scheduled jobs. If this attribute is null or omitted, the job uses the default timeout length, which corresponds to the Default timeout setting in the Vault UI. Learn more about timeout duration in Vault Help.

Supported Operations

Operation	Support
Create
Recreate
Alter	^*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

Alter: MDL Operation may not be supported for some multi-value attributes.