com.mailslurp.models

Class WebhookNewAttachmentPayload

java.lang.Object

com.mailslurp.models.WebhookNewAttachmentPayload

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class WebhookNewAttachmentPayload
extends Object

NEW_ATTACHMENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains an attachment. You can use the attachmentId to download the attachment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookNewAttachmentPayload.CustomTypeAdapterFactory
static class	WebhookNewAttachmentPayload.EventNameEnum Name of the event type webhook is being triggered for.

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ATTACHMENT_ID
static String	SERIALIZED_NAME_CONTENT_LENGTH
static String	SERIALIZED_NAME_CONTENT_TYPE
static String	SERIALIZED_NAME_EVENT_NAME
static String	SERIALIZED_NAME_MESSAGE_ID
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_WEBHOOK_ID
static String	SERIALIZED_NAME_WEBHOOK_NAME

Constructor Summary

Constructors

Constructor and Description
WebhookNewAttachmentPayload()

Method Summary

Modifier and Type	Method and Description
WebhookNewAttachmentPayload	attachmentId(String attachmentId)
WebhookNewAttachmentPayload	contentLength(Long contentLength)
WebhookNewAttachmentPayload	contentType(String contentType)
boolean	equals(Object o)
WebhookNewAttachmentPayload	eventName(WebhookNewAttachmentPayload.EventNameEnum eventName)
static WebhookNewAttachmentPayload	fromJson(String jsonString) Create an instance of WebhookNewAttachmentPayload given an JSON string
String	getAttachmentId() ID of attachment.
Long	getContentLength() Size of attachment in bytes
String	getContentType() Content type of attachment such as 'image/png' or 'application/pdf
WebhookNewAttachmentPayload.EventNameEnum	getEventName() Name of the event type webhook is being triggered for.
String	getMessageId() Idempotent message ID.
String	getName() Filename of the attachment if present
UUID	getWebhookId() ID of webhook entity being triggered
String	getWebhookName() Name of the webhook being triggered
int	hashCode()
WebhookNewAttachmentPayload	messageId(String messageId)
WebhookNewAttachmentPayload	name(String name)
void	setAttachmentId(String attachmentId)
void	setContentLength(Long contentLength)
void	setContentType(String contentType)
void	setEventName(WebhookNewAttachmentPayload.EventNameEnum eventName)
void	setMessageId(String messageId)
void	setName(String name)
void	setWebhookId(UUID webhookId)
void	setWebhookName(String webhookName)
String	toJson() Convert an instance of WebhookNewAttachmentPayload to an JSON string
String	toString()
static void	validateJsonObject(com.google.gson.JsonObject jsonObj) Validates the JSON Object and throws an exception if issues found
WebhookNewAttachmentPayload	webhookId(UUID webhookId)
WebhookNewAttachmentPayload	webhookName(String webhookName)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_MESSAGE_ID

public static final String SERIALIZED_NAME_MESSAGE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_WEBHOOK_ID

public static final String SERIALIZED_NAME_WEBHOOK_ID

See Also:

Constant Field Values

SERIALIZED_NAME_WEBHOOK_NAME

public static final String SERIALIZED_NAME_WEBHOOK_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_EVENT_NAME

public static final String SERIALIZED_NAME_EVENT_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_ATTACHMENT_ID

public static final String SERIALIZED_NAME_ATTACHMENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_CONTENT_TYPE

public static final String SERIALIZED_NAME_CONTENT_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_CONTENT_LENGTH

public static final String SERIALIZED_NAME_CONTENT_LENGTH

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

WebhookNewAttachmentPayload

public WebhookNewAttachmentPayload()

Method Detail

messageId

public WebhookNewAttachmentPayload messageId(String messageId)

getMessageId

@Nonnull
public String getMessageId()

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

Returns:

messageId

setMessageId

public void setMessageId(String messageId)

webhookId

public WebhookNewAttachmentPayload webhookId(UUID webhookId)

getWebhookId

@Nonnull
public UUID getWebhookId()

ID of webhook entity being triggered

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

webhookName

public WebhookNewAttachmentPayload webhookName(String webhookName)

getWebhookName

@Nullable
public String getWebhookName()

Name of the webhook being triggered

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

eventName

public WebhookNewAttachmentPayload eventName(WebhookNewAttachmentPayload.EventNameEnum eventName)

getEventName

@Nonnull
public WebhookNewAttachmentPayload.EventNameEnum getEventName()

Name of the event type webhook is being triggered for.

Returns:

eventName

setEventName

public void setEventName(WebhookNewAttachmentPayload.EventNameEnum eventName)

attachmentId

public WebhookNewAttachmentPayload attachmentId(String attachmentId)

getAttachmentId

@Nonnull
public String getAttachmentId()

ID of attachment. Use the `AttachmentController` to

Returns:

attachmentId

setAttachmentId

public void setAttachmentId(String attachmentId)

name

public WebhookNewAttachmentPayload name(String name)

getName

@Nonnull
public String getName()

Filename of the attachment if present

Returns:

name

setName

public void setName(String name)

contentType

public WebhookNewAttachmentPayload contentType(String contentType)

getContentType

@Nonnull
public String getContentType()

Content type of attachment such as 'image/png' or 'application/pdf

Returns:

contentType

setContentType

public void setContentType(String contentType)

contentLength

public WebhookNewAttachmentPayload contentLength(Long contentLength)

getContentLength

@Nonnull
public Long getContentLength()

Size of attachment in bytes

Returns:

contentLength

setContentLength

public void setContentLength(Long contentLength)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to WebhookNewAttachmentPayload

fromJson

public static WebhookNewAttachmentPayload fromJson(String jsonString)
                                            throws IOException

Create an instance of WebhookNewAttachmentPayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookNewAttachmentPayload

Throws:

IOException - if the JSON string is invalid with respect to WebhookNewAttachmentPayload

toJson

public String toJson()

Convert an instance of WebhookNewAttachmentPayload to an JSON string

Returns:

JSON string