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

Class ActorResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ActorResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ActorResponse extends Object
Cryptographic Actor — the operational identity that authenticates and executes cryptographic operations on behalf of its parent Application.

  • Field Details

  • Constructor Details

    • ActorResponse

      public ActorResponse()

  • Method Details

    • getActorTypeAsString

      public String getActorTypeAsString()
      The wire value of actorType: 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 getActorType() 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

    • actorType

      public ActorResponse actorType(@Nonnull ActorResponse.ActorTypeEnum actorType)

    • getActorType

      @Nonnull public ActorResponse.ActorTypeEnum getActorType()
      Operational classification
      Returns:
      actorType

    • setActorType

      public void setActorType(@Nonnull ActorResponse.ActorTypeEnum actorType)

    • applicationId

      public ActorResponse applicationId(@Nonnull UUID applicationId)

    • getApplicationId

      @Nonnull public UUID getApplicationId()
      Parent business Application UUID
      Returns:
      applicationId

    • setApplicationId

      public void setApplicationId(@Nonnull UUID applicationId)

    • applicationName

      public ActorResponse applicationName(@Nullable String applicationName)

    • getApplicationName

      @Nullable public String getApplicationName()
      Parent business Application name — enriched server-side from the @ManyToOne Application association so list views can render a human-readable label without an extra round-trip.
      Returns:
      applicationName

    • setApplicationName

      public void setApplicationName(@Nullable String applicationName)

    • createdAt

      public ActorResponse createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

      @Nonnull public OffsetDateTime getCreatedAt()
      Timestamp the Actor record was created
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • description

      public ActorResponse description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Free-text description of the Actor's operational role
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • displayName

      public ActorResponse displayName(@Nullable String displayName)

    • getDisplayName

      @Nullable public String getDisplayName()
      Human-readable label for UI / reports
      Returns:
      displayName

    • setDisplayName

      public void setDisplayName(@Nullable String displayName)

    • id

      public ActorResponse id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      Actor UUID (JWT sub claim at authentication time)
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • isDefault

      public ActorResponse isDefault(@Nonnull Boolean isDefault)

    • getIsDefault

      @Nonnull public Boolean getIsDefault()
      True iff this Actor was auto-provisioned when the parent Application was created
      Returns:
      isDefault

    • setIsDefault

      public void setIsDefault(@Nonnull Boolean isDefault)

    • name

      public ActorResponse name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Technical slug unique within the parent Application
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • purpose

      public ActorResponse purpose(@Nullable String purpose)

    • getPurpose

      @Nullable public String getPurpose()
      Purpose tag (visible to auditors)
      Returns:
      purpose

    • setPurpose

      public void setPurpose(@Nullable String purpose)

    • status

      public ActorResponse status(@Nonnull ActorResponse.StatusEnum status)

    • getStatus

      @Nonnull public ActorResponse.StatusEnum getStatus()
      Lifecycle state; only ACTIVE permits authentication
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull ActorResponse.StatusEnum status)

    • tenantId

      public ActorResponse tenantId(@Nonnull UUID tenantId)

    • getTenantId

      @Nonnull public UUID getTenantId()
      Tenant UUID this Actor belongs to
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(@Nonnull UUID tenantId)

    • updatedAt

      public ActorResponse updatedAt(@Nullable OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Timestamp of the last update to the Actor record
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)

    • validFrom

      public ActorResponse validFrom(@Nullable OffsetDateTime validFrom)

    • getValidFrom

      @Nullable public OffsetDateTime getValidFrom()
      Optional start of validity window (ISO-8601)
      Returns:
      validFrom

    • setValidFrom

      public void setValidFrom(@Nullable OffsetDateTime validFrom)

    • validUntil

      public ActorResponse validUntil(@Nullable OffsetDateTime validUntil)

    • getValidUntil

      @Nullable public OffsetDateTime getValidUntil()
      Optional end of validity window (ISO-8601)
      Returns:
      validUntil

    • setValidUntil

      public void setValidUntil(@Nullable OffsetDateTime validUntil)

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

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

    • fromJson

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

    • toJson

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