Package co.ankatech.keymanagement.client.keymanagement.model

Class ApplicationResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ApplicationResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ApplicationResponse extends Object
An application registered under a tenant: identity, lifecycle, business identity, ownership, risk classification and metadata, as stored. Every member is present in the body, a value never entered being null; `defaultActorId` is present on the create response only.

  • Field Details

  • Constructor Details

    • ApplicationResponse

      public ApplicationResponse()

  • Method Details

    • getDataClassificationAsString

      public String getDataClassificationAsString()
      The wire value of dataClassification: 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 getDataClassification() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire value, or null when the member is absent

    • getEnvironmentAsString

      public String getEnvironmentAsString()
      The wire value of environment: 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 getEnvironment() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire value, or null when the member is absent

    • getPrincipalTypeAsString

      public String getPrincipalTypeAsString()
      The wire value of principalType: 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 getPrincipalType() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire value, or null when the member is absent

    • getRiskLevelAsString

      public String getRiskLevelAsString()
      The wire value of riskLevel: 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 getRiskLevel() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire value, or null when the member is absent

    • getStatusAsString

      public String getStatusAsString()
      The wire value of status: 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 getStatus() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire value, or null when the member is absent

    • businessUnit

      public ApplicationResponse businessUnit(@Nullable String businessUnit)

    • getBusinessUnit

      @Nullable public String getBusinessUnit()
      Organizational unit responsible for the application; null when none was entered.
      Returns:
      businessUnit

    • setBusinessUnit

      public void setBusinessUnit(@Nullable String businessUnit)

    • costCenter

      public ApplicationResponse costCenter(@Nullable String costCenter)

    • getCostCenter

      @Nullable public String getCostCenter()
      Cost center for chargeback; null when none was entered.
      Returns:
      costCenter

    • setCostCenter

      public void setCostCenter(@Nullable String costCenter)

    • createdAt

      public ApplicationResponse createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      When the application was created.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • dataClassification

      public ApplicationResponse dataClassification(@Nullable ApplicationResponse.DataClassificationEnum dataClassification)

    • getDataClassification

      @Nullable public ApplicationResponse.DataClassificationEnum getDataClassification()
      Sensitivity of the data the application handles. Never null: present on every application record this server returns.
      Returns:
      dataClassification

    • setDataClassification

      public void setDataClassification(@Nullable ApplicationResponse.DataClassificationEnum dataClassification)

    • defaultActorId

      public ApplicationResponse defaultActorId(@Nullable UUID defaultActorId)

    • getDefaultActorId

      @Nullable public UUID getDefaultActorId()
      UUID of the default Cryptographic Actor created in the same transaction as the application, the Actor a first credential is issued for. Present on the `createApplication` response only; absent from every other application response.
      Returns:
      defaultActorId

    • setDefaultActorId

      public void setDefaultActorId(@Nullable UUID defaultActorId)

    • description

      public ApplicationResponse description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Purpose and scope of the application; null when none was entered.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • displayName

      public ApplicationResponse displayName(@Nullable String displayName)

    • getDisplayName

      @Nullable public String getDisplayName()
      Business-domain name. Equal to `name` when none was entered.
      Returns:
      displayName

    • setDisplayName

      public void setDisplayName(@Nullable String displayName)

    • environment

      public ApplicationResponse environment(@Nullable ApplicationResponse.EnvironmentEnum environment)

    • getEnvironment

      @Nullable public ApplicationResponse.EnvironmentEnum getEnvironment()
      Environment classification. Never null: every application record carries it, `PRODUCTION` when none was entered at creation.
      Returns:
      environment

    • setEnvironment

      public void setEnvironment(@Nullable ApplicationResponse.EnvironmentEnum environment)

    • externalRefs

      public ApplicationResponse externalRefs(@Nullable Map<String,Object> externalRefs)

    • putExternalRefsItem

      public ApplicationResponse putExternalRefsItem(String key, Object externalRefsItem)

    • getExternalRefs

      @Nullable public Map<String,Object> getExternalRefs()
      References to external systems such as a CMDB or an issue tracker; empty when none were entered.
      Returns:
      externalRefs

    • setExternalRefs

      public void setExternalRefs(@Nullable Map<String,Object> externalRefs)

    • id

      public ApplicationResponse id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      UUID of the application.
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • loginId

      public ApplicationResponse loginId(@Nonnull String loginId)

    • getLoginId

      @Nonnull public String getLoginId()
      Client identifier of the application, equal to `id`.
      Returns:
      loginId

    • setLoginId

      public void setLoginId(@Nonnull String loginId)

    • name

      public ApplicationResponse name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Service-identity slug, unique among the tenant's live applications compared case-insensitively.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • ownerEmail

      public ApplicationResponse ownerEmail(@Nullable String ownerEmail)

    • getOwnerEmail

      @Nullable public String getOwnerEmail()
      Business owner's e-mail address; null when none was entered.
      Returns:
      ownerEmail

    • setOwnerEmail

      public void setOwnerEmail(@Nullable String ownerEmail)

    • ownerName

      public ApplicationResponse ownerName(@Nullable String ownerName)

    • getOwnerName

      @Nullable public String getOwnerName()
      Business owner of the application; null when none was entered.
      Returns:
      ownerName

    • setOwnerName

      public void setOwnerName(@Nullable String ownerName)

    • principalType

      public ApplicationResponse principalType(@Nonnull ApplicationResponse.PrincipalTypeEnum principalType)

    • getPrincipalType

      @Nonnull public ApplicationResponse.PrincipalTypeEnum getPrincipalType()
      Kind of principal; always `APPLICATION` on this record.
      Returns:
      principalType

    • setPrincipalType

      public void setPrincipalType(@Nonnull ApplicationResponse.PrincipalTypeEnum principalType)

    • regulatoryScope

      public ApplicationResponse regulatoryScope(@Nullable List<String> regulatoryScope)

    • addRegulatoryScopeItem

      public ApplicationResponse addRegulatoryScopeItem(String regulatoryScopeItem)

    • getRegulatoryScope

      @Nullable public List<String> getRegulatoryScope()
      Regulations that apply to the application; empty when none was entered.
      Returns:
      regulatoryScope

    • setRegulatoryScope

      public void setRegulatoryScope(@Nullable List<String> regulatoryScope)

    • riskLevel

      public ApplicationResponse riskLevel(@Nullable ApplicationResponse.RiskLevelEnum riskLevel)

    • getRiskLevel

      @Nullable public ApplicationResponse.RiskLevelEnum getRiskLevel()
      Operational risk level. Never null: present on every application record this server returns.
      Returns:
      riskLevel

    • setRiskLevel

      public void setRiskLevel(@Nullable ApplicationResponse.RiskLevelEnum riskLevel)

    • roles

      public ApplicationResponse roles(@Nonnull List<String> roles)

    • addRolesItem

      public ApplicationResponse addRolesItem(String rolesItem)

    • getRoles

      @Nonnull public List<String> getRoles()
      Always empty: an application's authority lives on its Cryptographic Actors.
      Returns:
      roles

    • setRoles

      public void setRoles(@Nonnull List<String> roles)

    • status

      public ApplicationResponse status(@Nullable ApplicationResponse.StatusEnum status)

    • getStatus

      @Nullable public ApplicationResponse.StatusEnum getStatus()
      Lifecycle status of the application: `ACTIVE`, `SUSPENDED` (temporarily not admitted to cryptographic operations) or `DISABLED`.
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable ApplicationResponse.StatusEnum status)

    • tags

      public ApplicationResponse tags(@Nullable Map<String,Object> tags)

    • putTagsItem

      public ApplicationResponse putTagsItem(String key, Object tagsItem)

    • getTags

      @Nullable public Map<String,Object> getTags()
      Free-form tags; empty when none were entered.
      Returns:
      tags

    • setTags

      public void setTags(@Nullable Map<String,Object> tags)

    • technicalContactEmail

      public ApplicationResponse technicalContactEmail(@Nullable String technicalContactEmail)

    • getTechnicalContactEmail

      @Nullable public String getTechnicalContactEmail()
      Technical contact's e-mail address; null when none was entered.
      Returns:
      technicalContactEmail

    • setTechnicalContactEmail

      public void setTechnicalContactEmail(@Nullable String technicalContactEmail)

    • technicalContactName

      public ApplicationResponse technicalContactName(@Nullable String technicalContactName)

    • getTechnicalContactName

      @Nullable public String getTechnicalContactName()
      Technical contact for the application; null when none was entered.
      Returns:
      technicalContactName

    • setTechnicalContactName

      public void setTechnicalContactName(@Nullable String technicalContactName)

    • tenantId

      public ApplicationResponse tenantId(@Nonnull String tenantId)

    • getTenantId

      @Nonnull public String getTenantId()
      UUID of the tenant that owns the application.
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(@Nonnull String tenantId)

    • updatedAt

      public ApplicationResponse updatedAt(@Nullable OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      When the application was last updated.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)

    • 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 ApplicationResponse

    • 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 of validateJsonElement(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 ApplicationResponse

    • fromJson

      public static ApplicationResponse fromJson(String jsonString) throws IOException
      Create an instance of ApplicationResponse given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of ApplicationResponse
      Throws:
      IOException - if the JSON string is invalid with respect to ApplicationResponse

    • toJson

      public String toJson()
      Convert an instance of ApplicationResponse to an JSON string
      Returns:
      JSON string