Class ExchangeUpdateRequest
java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ExchangeUpdateRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.23.0")
public class ExchangeUpdateRequest
extends Object
PATCH-style update for DRAFT or READY Exchange. References mutated on READY demote to DRAFT.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddTagsItem(String tagsItem) applicationId(UUID applicationId) businessPurpose(String businessPurpose) constraintPolicyId(UUID constraintPolicyId) effectiveFrom(OffsetDateTime effectiveFrom) effectiveUntil(OffsetDateTime effectiveUntil) booleanexchangeContextId(UUID exchangeContextId) static ExchangeUpdateRequestCreate an instance of ExchangeUpdateRequest given an JSON stringActor reference (optional).Application reference (optional).Asset KID (optional).Business purpose (optional)Constraint Policy (optional).Optional.Optional.Exchange Context (optional).getName()Display name (optional)getNotes()Notes (optional)Owner principal (optional)getTags()Tags (optional, replaces existing list when provided)Optimistic-lock version of the ExchangeinthashCode()ownerPrincipalId(UUID ownerPrincipalId) voidsetActorId(UUID actorId) voidsetApplicationId(UUID applicationId) voidsetAssetKid(String assetKid) voidsetBusinessPurpose(String businessPurpose) voidsetConstraintPolicyId(UUID constraintPolicyId) voidsetEffectiveFrom(OffsetDateTime effectiveFrom) voidsetEffectiveUntil(OffsetDateTime effectiveUntil) voidsetExchangeContextId(UUID exchangeContextId) voidvoidvoidsetOwnerPrincipalId(UUID ownerPrincipalId) voidvoidsetVersion(Integer version) toJson()Convert an instance of ExchangeUpdateRequest 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_ACTOR_ID
- See Also:
-
SERIALIZED_NAME_APPLICATION_ID
- See Also:
-
SERIALIZED_NAME_ASSET_KID
- See Also:
-
SERIALIZED_NAME_BUSINESS_PURPOSE
- See Also:
-
SERIALIZED_NAME_CONSTRAINT_POLICY_ID
- See Also:
-
SERIALIZED_NAME_EFFECTIVE_FROM
- See Also:
-
SERIALIZED_NAME_EFFECTIVE_UNTIL
- See Also:
-
SERIALIZED_NAME_EXCHANGE_CONTEXT_ID
- See Also:
-
SERIALIZED_NAME_NAME
- See Also:
-
SERIALIZED_NAME_NOTES
- See Also:
-
SERIALIZED_NAME_OWNER_PRINCIPAL_ID
- See Also:
-
SERIALIZED_NAME_TAGS
- See Also:
-
SERIALIZED_NAME_VERSION
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
ExchangeUpdateRequest
public ExchangeUpdateRequest()
-
-
Method Details
-
actorId
-
getActorId
Actor reference (optional). Mutating on READY demotes to DRAFT.- Returns:
- actorId
-
setActorId
-
applicationId
-
getApplicationId
Application reference (optional). Mutating on READY demotes to DRAFT.- Returns:
- applicationId
-
setApplicationId
-
assetKid
-
getAssetKid
Asset KID (optional). Mutating on READY demotes to DRAFT.- Returns:
- assetKid
-
setAssetKid
-
businessPurpose
-
getBusinessPurpose
Business purpose (optional)- Returns:
- businessPurpose
-
setBusinessPurpose
-
constraintPolicyId
-
getConstraintPolicyId
Constraint Policy (optional). Mutating on READY demotes to DRAFT.- Returns:
- constraintPolicyId
-
setConstraintPolicyId
-
effectiveFrom
-
getEffectiveFrom
Optional. Validity window start, inclusive: an RFC 3339 instant WITH an offset (Z or +hh:mm). A value without an offset is refused with 400 naming the member. Stored and returned in UTC; the cryptographic service refuses the Exchange's grant before this instant.- Returns:
- effectiveFrom
-
setEffectiveFrom
-
effectiveUntil
-
getEffectiveUntil
Optional. Validity window end, exclusive — must be after effectiveFrom when both are set: an RFC 3339 instant WITH an offset; a value without one is refused with 400 naming the member. Stored and returned in UTC; the cryptographic service refuses the Exchange's grant from this instant on, whether or not the expiry job has yet moved the Exchange to EXPIRED.- Returns:
- effectiveUntil
-
setEffectiveUntil
-
exchangeContextId
-
getExchangeContextId
Exchange Context (optional). Mutating on READY demotes to DRAFT.- Returns:
- exchangeContextId
-
setExchangeContextId
-
name
-
getName
Display name (optional)- Returns:
- name
-
setName
-
notes
-
getNotes
Notes (optional)- Returns:
- notes
-
setNotes
-
ownerPrincipalId
-
getOwnerPrincipalId
Owner principal (optional)- Returns:
- ownerPrincipalId
-
setOwnerPrincipalId
-
tags
-
addTagsItem
-
getTags
Tags (optional, replaces existing list when provided)- Returns:
- tags
-
setTags
-
version
-
getVersion
Optimistic-lock version of the Exchange- Returns:
- version
-
setVersion
-
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 ExchangeUpdateRequest
-
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 ExchangeUpdateRequest
-
fromJson
Create an instance of ExchangeUpdateRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of ExchangeUpdateRequest
- Throws:
IOException- if the JSON string is invalid with respect to ExchangeUpdateRequest
-
toJson
Convert an instance of ExchangeUpdateRequest to an JSON string- Returns:
- JSON string
-