Package org.opensearch.jobscheduler.model

Class ExtensionJobParameter

java.lang.Object

org.opensearch.jobscheduler.model.ExtensionJobParameter

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, org.opensearch.jobscheduler.spi.ScheduledJobParameter

public class ExtensionJobParameter
extends Object
implements org.opensearch.jobscheduler.spi.ScheduledJobParameter, org.opensearch.core.common.io.stream.Writeable

A Writeable ScheduledJobParameter used to transport job parameters between OpenSearch and Extensions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExtensionJobParameter.ScheduleType	Enum for Schedule types used to indicate which Schedule constructor to use to read from/write to the stream.

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLED_TIME_FIELD
static final String	IS_ENABLED_FIELD
static final String	JITTER_FIELD
static final String	LAST_UPDATE_TIME_FIELD
static final String	LOCK_DURATION_SECONDS_FIELD
static final String	NAME_FIELD
static final String	SCHEDULE_FIELD

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ExtensionJobParameter(String jobName, org.opensearch.jobscheduler.spi.schedule.Schedule schedule, Instant lastUpdateTime, Instant enabledTime, boolean isEnabled, Long lockDurationSeconds, Double jitter)
ExtensionJobParameter(org.opensearch.core.common.io.stream.StreamInput in)
ExtensionJobParameter(org.opensearch.jobscheduler.spi.ScheduledJobParameter jobParameter)

Method Summary

Modifier and Type	Method	Description
Instant	getEnabledTime()
Double	getJitter()
Instant	getLastUpdateTime()
Long	getLockDurationSeconds()
String	getName()
org.opensearch.jobscheduler.spi.schedule.Schedule	getSchedule()
boolean	isEnabled()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

NAME_FIELD

public static final String NAME_FIELD

See Also:

• Constant Field Values

SCHEDULE_FIELD

public static final String SCHEDULE_FIELD

See Also:

• Constant Field Values

LAST_UPDATE_TIME_FIELD

public static final String LAST_UPDATE_TIME_FIELD

See Also:

• Constant Field Values

ENABLED_TIME_FIELD

public static final String ENABLED_TIME_FIELD

See Also:

• Constant Field Values

IS_ENABLED_FIELD

public static final String IS_ENABLED_FIELD

See Also:

• Constant Field Values

LOCK_DURATION_SECONDS_FIELD

public static final String LOCK_DURATION_SECONDS_FIELD

See Also:

• Constant Field Values

JITTER_FIELD

public static final String JITTER_FIELD

See Also:

• Constant Field Values

Constructor Details

ExtensionJobParameter

public ExtensionJobParameter(String jobName,
 org.opensearch.jobscheduler.spi.schedule.Schedule schedule,
 Instant lastUpdateTime,
 Instant enabledTime,
 boolean isEnabled,
 Long lockDurationSeconds,
 Double jitter)

ExtensionJobParameter

public ExtensionJobParameter(org.opensearch.jobscheduler.spi.ScheduledJobParameter jobParameter)

ExtensionJobParameter

public ExtensionJobParameter(org.opensearch.core.common.io.stream.StreamInput in)
                      throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

getName

public String getName()

Specified by:

getName in interface org.opensearch.jobscheduler.spi.ScheduledJobParameter

getLastUpdateTime

public Instant getLastUpdateTime()

Specified by:

getLastUpdateTime in interface org.opensearch.jobscheduler.spi.ScheduledJobParameter

getEnabledTime

public Instant getEnabledTime()

Specified by:

getEnabledTime in interface org.opensearch.jobscheduler.spi.ScheduledJobParameter

getSchedule

public org.opensearch.jobscheduler.spi.schedule.Schedule getSchedule()

Specified by:

getSchedule in interface org.opensearch.jobscheduler.spi.ScheduledJobParameter

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface org.opensearch.jobscheduler.spi.ScheduledJobParameter

getLockDurationSeconds

public Long getLockDurationSeconds()

Specified by:

getLockDurationSeconds in interface org.opensearch.jobscheduler.spi.ScheduledJobParameter

getJitter

public Double getJitter()

Specified by:

getJitter in interface org.opensearch.jobscheduler.spi.ScheduledJobParameter