Package org.jenkinsci.plugins.pubsub

Enum Class EventProps.Jenkins

java.lang.Object

java.lang.Enum<EventProps.Jenkins>

org.jenkinsci.plugins.pubsub.EventProps.Jenkins

All Implemented Interfaces:

Serializable, Comparable<EventProps.Jenkins>, Constable

Enclosing interface:

EventProps

public static enum EventProps.Jenkins
extends Enum<EventProps.Jenkins>

Pre-defined Jenkins/core event property names.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
jenkins_channel	The event channel name on which the message was sent.
jenkins_event	The event name.
jenkins_event_timestamp	The millisecond timestamp for when the event happened.
jenkins_event_uuid	The event UUID.
jenkins_instance_id	The ID of the Jenkins instance that published the message.
jenkins_instance_url	The URL of the Jenkins instance that published the message.
jenkins_object_id	Jenkins domain object unique ID.
jenkins_object_name	Jenkins domain object full name.
jenkins_object_type	Jenkins domain object type.
jenkins_object_url	Jenkins domain object URL.
jenkins_org	The Jenkins organization origin of the event.

Method Summary

Modifier and Type	Method	Description
static EventProps.Jenkins	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EventProps.Jenkins[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

jenkins_org

public static final EventProps.Jenkins jenkins_org

The Jenkins organization origin of the event.

jenkins_instance_id

public static final EventProps.Jenkins jenkins_instance_id

The ID of the Jenkins instance that published the message.

jenkins_instance_url

public static final EventProps.Jenkins jenkins_instance_url

The URL of the Jenkins instance that published the message.

jenkins_channel

public static final EventProps.Jenkins jenkins_channel

The event channel name on which the message was sent.

jenkins_event

public static final EventProps.Jenkins jenkins_event

The event name. See Events for pre-defined types.

jenkins_event_timestamp

public static final EventProps.Jenkins jenkins_event_timestamp

The millisecond timestamp for when the event happened.

Of course, this does not preclude the event message from containing other timestamp event properties, where appropriate.

jenkins_event_uuid

public static final EventProps.Jenkins jenkins_event_uuid

The event UUID.

jenkins_object_type

public static final EventProps.Jenkins jenkins_object_type

Jenkins domain object type.

jenkins_object_name

public static final EventProps.Jenkins jenkins_object_name

Jenkins domain object full name.

jenkins_object_id

public static final EventProps.Jenkins jenkins_object_id

Jenkins domain object unique ID.

jenkins_object_url

public static final EventProps.Jenkins jenkins_object_url

Jenkins domain object URL.

Method Details

values

public static EventProps.Jenkins[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EventProps.Jenkins valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null