Package io.jenkins.plugins.webhookexternalstore

Record Class WebhookPayload

java.lang.Object

java.lang.Record

io.jenkins.plugins.webhookexternalstore.WebhookPayload

public record WebhookPayload(String id, String description, String type, Map<String,Object> secret)
extends Record

Represents the JSON payload received via webhook for credential creation/update.

Constructor Summary

Constructors

Constructor	Description
WebhookPayload(String id, String description, String type, Map<String,Object> secret)	Constructor for WebhookPayload.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static WebhookPayload	fromJSON(net.sf.json.JSONObject json)	Create a WebhookPayload from a JSONObject.
String	getDescription()
String	getId()
String	getSecretValue(String key)	Return a secret value field from the secret map.
String	getType()
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
Map<String,Object>	secret()	Returns the value of the secret record component.
String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WebhookPayload

public WebhookPayload(String id,
 String description,
 String type,
 Map<String,Object> secret)

Constructor for WebhookPayload.

Parameters:

id - ID of the credential

description - Description of the credential

type - Type of the credential

secret - Map containing secret fields

Method Details

fromJSON

public static WebhookPayload fromJSON(net.sf.json.JSONObject json)
                               throws CredentialsConvertionException

Create a WebhookPayload from a JSONObject.

Parameters:

json - the JSON object

Returns:

the webhook payload

Throws:

CredentialsConvertionException - if required fields are missing

getId

public String getId()

getDescription

public String getDescription()

getType

public String getType()

getSecretValue

public String getSecretValue(String key)

Return a secret value field from the secret map.

Parameters:

key - the key to look up in the secret map

Returns:

the secret value as a String, or null if not found or not a String

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

secret

public Map<String,Object> secret()

Returns the value of the secret record component.

Returns:

the value of the secret record component