Package markets.alpaca.client.openapi.broker.model

Class AdminActionTransactionCancel

java.lang.Object

markets.alpaca.client.openapi.broker.model.AdminActionTransactionCancel

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class AdminActionTransactionCancel
extends Object
implements Serializable

Represents structure of a TransactionCancel type AdminAction

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdminActionTransactionCancel.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_AT
static final String	SERIALIZED_NAME_BELONGS_TO
static final String	SERIALIZED_NAME_CATEGORY
static final String	SERIALIZED_NAME_CONTEXT
static final String	SERIALIZED_NAME_CORRESPONDENT
static final String	SERIALIZED_NAME_CREATED_BY
static final String	SERIALIZED_NAME_EVENT_ID
static final String	SERIALIZED_NAME_NOTE
static final String	SERIALIZED_NAME_REPLACES_EVENT_ID
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_VISIBILITY

Constructor Summary

Constructors

Constructor	Description
AdminActionTransactionCancel()

Method Summary

Modifier and Type	Method	Description
AdminActionTransactionCancel	at(OffsetDateTime at)
AdminActionTransactionCancel	belongsTo(AdminActionBelongsTo belongsTo)
AdminActionTransactionCancel	category(AdminActionCategory category)
AdminActionTransactionCancel	context(AdminActionContextTransactionCancelContext context)
AdminActionTransactionCancel	correspondent(String correspondent)
AdminActionTransactionCancel	createdBy(AdminActionCreatedBy createdBy)
boolean	equals(Object o)
AdminActionTransactionCancel	eventId(String eventId)
static AdminActionTransactionCancel	fromJson(String jsonString)	Create an instance of AdminActionTransactionCancel given an JSON string
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
OffsetDateTime	getAt()	Timestamp of event
AdminActionBelongsTo	getBelongsTo()	Get belongsTo
AdminActionCategory	getCategory()	Get category
AdminActionContextTransactionCancelContext	getContext()	Get context
String	getCorrespondent()	Related correspondent
AdminActionCreatedBy	getCreatedBy()	Get createdBy
String	getEventId()	Lexically sortable, monotonically increasing character array
String	getNote()	Free text form description of the admin action
String	getReplacesEventId()	Id of the replaced event (optional)
AdminActionType	getType()	Get type
AdminActionVisibility	getVisibility()	Get visibility
int	hashCode()
AdminActionTransactionCancel	note(String note)
AdminActionTransactionCancel	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
AdminActionTransactionCancel	replacesEventId(String replacesEventId)
void	setAt(OffsetDateTime at)
void	setBelongsTo(AdminActionBelongsTo belongsTo)
void	setCategory(AdminActionCategory category)
void	setContext(AdminActionContextTransactionCancelContext context)
void	setCorrespondent(String correspondent)
void	setCreatedBy(AdminActionCreatedBy createdBy)
void	setEventId(String eventId)
void	setNote(String note)
void	setReplacesEventId(String replacesEventId)
void	setType(AdminActionType type)
void	setVisibility(AdminActionVisibility visibility)
String	toJson()	Convert an instance of AdminActionTransactionCancel to an JSON string
String	toString()
AdminActionTransactionCancel	type(AdminActionType type)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found
AdminActionTransactionCancel	visibility(AdminActionVisibility visibility)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_AT

public static final String SERIALIZED_NAME_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_BELONGS_TO

public static final String SERIALIZED_NAME_BELONGS_TO

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY

public static final String SERIALIZED_NAME_CATEGORY

See Also:

• Constant Field Values

SERIALIZED_NAME_CORRESPONDENT

public static final String SERIALIZED_NAME_CORRESPONDENT

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_BY

public static final String SERIALIZED_NAME_CREATED_BY

See Also:

• Constant Field Values

SERIALIZED_NAME_EVENT_ID

public static final String SERIALIZED_NAME_EVENT_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_NOTE

public static final String SERIALIZED_NAME_NOTE

See Also:

• Constant Field Values

SERIALIZED_NAME_REPLACES_EVENT_ID

public static final String SERIALIZED_NAME_REPLACES_EVENT_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_VISIBILITY

public static final String SERIALIZED_NAME_VISIBILITY

See Also:

• Constant Field Values

SERIALIZED_NAME_CONTEXT

public static final String SERIALIZED_NAME_CONTEXT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

AdminActionTransactionCancel

public AdminActionTransactionCancel()

Method Details

at

public AdminActionTransactionCancel at(@Nonnull
 OffsetDateTime at)

getAt

@Nonnull
public OffsetDateTime getAt()

Timestamp of event

Returns:

at

setAt

public void setAt(@Nonnull
 OffsetDateTime at)

belongsTo

public AdminActionTransactionCancel belongsTo(@Nonnull
 AdminActionBelongsTo belongsTo)

getBelongsTo

@Nonnull
public AdminActionBelongsTo getBelongsTo()

Get belongsTo

Returns:

belongsTo

setBelongsTo

public void setBelongsTo(@Nonnull
 AdminActionBelongsTo belongsTo)

category

public AdminActionTransactionCancel category(@Nonnull
 AdminActionCategory category)

getCategory

@Nonnull
public AdminActionCategory getCategory()

Get category

Returns:

category

setCategory

public void setCategory(@Nonnull
 AdminActionCategory category)

correspondent

public AdminActionTransactionCancel correspondent(@Nonnull
 String correspondent)

getCorrespondent

@Nonnull
public String getCorrespondent()

Related correspondent

Returns:

correspondent

setCorrespondent

public void setCorrespondent(@Nonnull
 String correspondent)

createdBy

public AdminActionTransactionCancel createdBy(@Nonnull
 AdminActionCreatedBy createdBy)

getCreatedBy

@Nonnull
public AdminActionCreatedBy getCreatedBy()

Get createdBy

Returns:

createdBy

setCreatedBy

public void setCreatedBy(@Nonnull
 AdminActionCreatedBy createdBy)

eventId

public AdminActionTransactionCancel eventId(@Nonnull
 String eventId)

getEventId

@Nonnull
public String getEventId()

Lexically sortable, monotonically increasing character array

Returns:

eventId

setEventId

public void setEventId(@Nonnull
 String eventId)

note

public AdminActionTransactionCancel note(@Nonnull
 String note)

getNote

@Nonnull
public String getNote()

Free text form description of the admin action

Returns:

note

setNote

public void setNote(@Nonnull
 String note)

replacesEventId

public AdminActionTransactionCancel replacesEventId(@Nullable
 String replacesEventId)

getReplacesEventId

@Nullable
public String getReplacesEventId()

Id of the replaced event (optional)

Returns:

replacesEventId

setReplacesEventId

public void setReplacesEventId(@Nullable
 String replacesEventId)

type

public AdminActionTransactionCancel type(@Nonnull
 AdminActionType type)

getType

@Nonnull
public AdminActionType getType()

Get type

Returns:

type

setType

public void setType(@Nonnull
 AdminActionType type)

visibility

public AdminActionTransactionCancel visibility(@Nonnull
 AdminActionVisibility visibility)

getVisibility

@Nonnull
public AdminActionVisibility getVisibility()

Get visibility

Returns:

visibility

setVisibility

public void setVisibility(@Nonnull
 AdminActionVisibility visibility)

context

public AdminActionTransactionCancel context(@Nonnull
 AdminActionContextTransactionCancelContext context)

getContext

@Nonnull
public AdminActionContextTransactionCancelContext getContext()

Get context

Returns:

context

setContext

public void setContext(@Nonnull
 AdminActionContextTransactionCancelContext context)

putAdditionalProperty

public AdminActionTransactionCancel putAdditionalProperty(String key,
 Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the AdminActionTransactionCancel instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

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

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to AdminActionTransactionCancel

fromJson

public static AdminActionTransactionCancel fromJson(String jsonString)
                                             throws IOException

Create an instance of AdminActionTransactionCancel given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of AdminActionTransactionCancel

Throws:

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

toJson

public String toJson()

Convert an instance of AdminActionTransactionCancel to an JSON string

Returns:

JSON string