Class CreateExchangeContextRequest
java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.CreateExchangeContextRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.23.0")
public class CreateExchangeContextRequest
extends Object
CreateExchangeContextRequest
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumFlow direction.static enumData classification of the exchanged payload -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbusinessPurpose(String businessPurpose) counterparty(String counterparty) counterpartyTypeId(UUID counterpartyTypeId) description(String description) displayName(String displayName) booleanstatic CreateExchangeContextRequestCreate an instance of CreateExchangeContextRequest given an JSON stringBusiness purpose of the exchange (visible to auditors)Counterparty name (partner, vendor, regulator)Optional FK to the counterparty type catalog.Free-text description of the exchange relationshipFlow direction.The wire value ofdirection: what the server sent, verbatim.Human-readable labelgetName()Technical slug unique within the Application.Data classification of the exchanged payloadThe wire value ofsensitivity: what the server sent, verbatim.inthashCode()sensitivity(CreateExchangeContextRequest.SensitivityEnum sensitivity) voidsetBusinessPurpose(String businessPurpose) voidsetCounterparty(String counterparty) voidsetCounterpartyTypeId(UUID counterpartyTypeId) voidsetDescription(String description) voidvoidsetDisplayName(String displayName) voidvoidtoJson()Convert an instance of CreateExchangeContextRequest to an JSON stringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues foundstatic voidvalidateJsonElementAsCandidate(com.google.gson.JsonElement jsonElement) Validates the JSON Element as a candidate of a oneOf schema: the checks ofvalidateJsonElement(JsonElement), and the element carries no member this model does not declare.
-
Field Details
-
SERIALIZED_NAME_BUSINESS_PURPOSE
- See Also:
-
SERIALIZED_NAME_COUNTERPARTY
- See Also:
-
SERIALIZED_NAME_COUNTERPARTY_TYPE_ID
- See Also:
-
SERIALIZED_NAME_DESCRIPTION
- See Also:
-
SERIALIZED_NAME_DIRECTION
- See Also:
-
SERIALIZED_NAME_DISPLAY_NAME
- See Also:
-
SERIALIZED_NAME_NAME
- See Also:
-
SERIALIZED_NAME_SENSITIVITY
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
CreateExchangeContextRequest
public CreateExchangeContextRequest()
-
-
Method Details
-
getDirectionAsString
The wire value ofdirection: what the server sent, verbatim.- For a value this release declares, the same wire value the enum names.
- For a value it does not declare (one a later server added), the server's wire value verbatim,
while
getDirection()readsUNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel. - For an absent member,
null.
- Returns:
- the wire value, or
nullwhen the member is absent
-
getSensitivityAsString
The wire value ofsensitivity: what the server sent, verbatim.- For a value this release declares, the same wire value the enum names.
- For a value it does not declare (one a later server added), the server's wire value verbatim,
while
getSensitivity()readsUNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel. - For an absent member,
null.
- Returns:
- the wire value, or
nullwhen the member is absent
-
businessPurpose
-
getBusinessPurpose
Business purpose of the exchange (visible to auditors)- Returns:
- businessPurpose
-
setBusinessPurpose
-
counterparty
-
getCounterparty
Counterparty name (partner, vendor, regulator)- Returns:
- counterparty
-
setCounterparty
-
counterpartyTypeId
-
getCounterpartyTypeId
Optional FK to the counterparty type catalog. The id MUST belong to the same tenant as the Exchange Context, OR be a platform-global type (tenant_id IS NULL). Cross-tenant references return 403.- Returns:
- counterpartyTypeId
-
setCounterpartyTypeId
-
description
-
getDescription
Free-text description of the exchange relationship- Returns:
- description
-
setDescription
-
direction
public CreateExchangeContextRequest direction(@Nonnull CreateExchangeContextRequest.DirectionEnum direction) -
getDirection
Flow direction. Immutable once set (fresh context for a new direction).- Returns:
- direction
-
setDirection
-
displayName
-
getDisplayName
Human-readable label- Returns:
- displayName
-
setDisplayName
-
name
-
getName
Technical slug unique within the Application. Lowercase alphanumerics and hyphens only.- Returns:
- name
-
setName
-
sensitivity
public CreateExchangeContextRequest sensitivity(@Nullable CreateExchangeContextRequest.SensitivityEnum sensitivity) -
getSensitivity
Data classification of the exchanged payload- Returns:
- sensitivity
-
setSensitivity
-
equals
-
hashCode
public int hashCode() -
toString
-
validateJsonElement
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 CreateExchangeContextRequest
-
validateJsonElementAsCandidate
public static void validateJsonElementAsCandidate(com.google.gson.JsonElement jsonElement) throws IOException Validates the JSON Element as a candidate of a oneOf schema: the checks ofvalidateJsonElement(JsonElement), and the element carries no member this model does not declare. A oneOf schema without a discriminator tells its candidates apart by their member sets, so a candidate is matched on its closed member set.- Parameters:
jsonElement- JSON Element- Throws:
IOException- if the JSON Element is not a CreateExchangeContextRequest
-
fromJson
Create an instance of CreateExchangeContextRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of CreateExchangeContextRequest
- Throws:
IOException- if the JSON string is invalid with respect to CreateExchangeContextRequest
-
toJson
Convert an instance of CreateExchangeContextRequest to an JSON string- Returns:
- JSON string
-