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

Class ExchangeGrantSummary

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ExchangeGrantSummary
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ExchangeGrantSummary extends Object
A Capability Grant the Exchange owns. The grant authorizes in the Exchange's Exchange Context, and only while the Exchange is ACTIVE.

  • Field Details

  • Constructor Details

    • ExchangeGrantSummary

      public ExchangeGrantSummary()

  • 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

    • actorId

      public ExchangeGrantSummary actorId(@Nullable UUID actorId)

    • getActorId

      @Nullable public UUID getActorId()
      The Cryptographic Actor the grant authorizes
      Returns:
      actorId

    • setActorId

      public void setActorId(@Nullable UUID actorId)

    • actorName

      public ExchangeGrantSummary actorName(@Nullable String actorName)

    • getActorName

      @Nullable public String getActorName()
      The actor's name
      Returns:
      actorName

    • setActorName

      public void setActorName(@Nullable String actorName)

    • actorType

      public ExchangeGrantSummary actorType(@Nullable ExchangeGrantSummary.ActorTypeEnum actorType)

    • getActorType

      @Nullable public ExchangeGrantSummary.ActorTypeEnum getActorType()
      The actor's type
      Returns:
      actorType

    • setActorType

      public void setActorType(@Nullable ExchangeGrantSummary.ActorTypeEnum actorType)

    • applicationId

      public ExchangeGrantSummary applicationId(@Nullable UUID applicationId)

    • getApplicationId

      @Nullable public UUID getApplicationId()
      The application the actor belongs to
      Returns:
      applicationId

    • setApplicationId

      public void setApplicationId(@Nullable UUID applicationId)

    • applicationName

      public ExchangeGrantSummary applicationName(@Nullable String applicationName)

    • getApplicationName

      @Nullable public String getApplicationName()
      That application's name
      Returns:
      applicationName

    • setApplicationName

      public void setApplicationName(@Nullable String applicationName)

    • assetKids

      public ExchangeGrantSummary assetKids(@Nullable List<String> assetKids)

    • addAssetKidsItem

      public ExchangeGrantSummary addAssetKidsItem(String assetKidsItem)

    • getAssetKids

      @Nullable public List<String> getAssetKids()
      The Key ID a basic grant authorizes; empty for a REENCRYPT or RESIGN grant
      Returns:
      assetKids

    • setAssetKids

      public void setAssetKids(@Nullable List<String> assetKids)

    • capabilities

      public ExchangeGrantSummary capabilities(@Nullable List<String> capabilities)

    • addCapabilitiesItem

      public ExchangeGrantSummary addCapabilitiesItem(String capabilitiesItem)

    • getCapabilities

      @Nullable public List<String> getCapabilities()
      The grant's capabilities
      Returns:
      capabilities

    • setCapabilities

      public void setCapabilities(@Nullable List<String> capabilities)

    • constraintPolicyId

      public ExchangeGrantSummary constraintPolicyId(@Nullable UUID constraintPolicyId)

    • getConstraintPolicyId

      @Nullable public UUID getConstraintPolicyId()
      The grant's Constraint Policy, or null
      Returns:
      constraintPolicyId

    • setConstraintPolicyId

      public void setConstraintPolicyId(@Nullable UUID constraintPolicyId)

    • constraintPolicyName

      public ExchangeGrantSummary constraintPolicyName(@Nullable String constraintPolicyName)

    • getConstraintPolicyName

      @Nullable public String getConstraintPolicyName()
      The Constraint Policy's name
      Returns:
      constraintPolicyName

    • setConstraintPolicyName

      public void setConstraintPolicyName(@Nullable String constraintPolicyName)

    • constraintPolicyVersion

      public ExchangeGrantSummary constraintPolicyVersion(@Nullable Integer constraintPolicyVersion)

    • getConstraintPolicyVersion

      @Nullable public Integer getConstraintPolicyVersion()
      The Constraint Policy version the grant enforces, or null
      Returns:
      constraintPolicyVersion

    • setConstraintPolicyVersion

      public void setConstraintPolicyVersion(@Nullable Integer constraintPolicyVersion)

    • effectiveState

      public ExchangeGrantSummary effectiveState(@Nonnull GrantEffectiveState effectiveState)

    • getEffectiveState

      @Nonnull public GrantEffectiveState getEffectiveState()
      Whether the governance objects the administration plane owns let the grant authorize at the instant of the read, and the first reason they do not
      Returns:
      effectiveState

    • setEffectiveState

      public void setEffectiveState(@Nonnull GrantEffectiveState effectiveState)

    • grantId

      public ExchangeGrantSummary grantId(@Nullable UUID grantId)

    • getGrantId

      @Nullable public UUID getGrantId()
      The grant
      Returns:
      grantId

    • setGrantId

      public void setGrantId(@Nullable UUID grantId)

    • keyPairs

      public ExchangeGrantSummary keyPairs(@Nullable List<CapabilityGrantKeyPair> keyPairs)

    • addKeyPairsItem

      public ExchangeGrantSummary addKeyPairsItem(CapabilityGrantKeyPair keyPairsItem)

    • getKeyPairs

      @Nullable public List<CapabilityGrantKeyPair> getKeyPairs()
      The ordered key pairs a REENCRYPT or RESIGN grant authorizes, each in its own direction only; empty for a basic grant
      Returns:
      keyPairs

    • setKeyPairs

      public void setKeyPairs(@Nullable List<CapabilityGrantKeyPair> keyPairs)

    • maxUsage

      public ExchangeGrantSummary maxUsage(@Nullable Long maxUsage)

    • getMaxUsage

      @Nullable public Long getMaxUsage()
      Total invocation ceiling of the pinned version; null when unlimited or when the grant has no Constraint Policy
      Returns:
      maxUsage

    • setMaxUsage

      public void setMaxUsage(@Nullable Long maxUsage)

    • operationPermissions

      public ExchangeGrantSummary operationPermissions(@Nullable ExchangeOperationPermissions operationPermissions)

    • getOperationPermissions

      @Nullable public ExchangeOperationPermissions getOperationPermissions()
      Whether the grant's actor holds the operation scopes the grant needs. Present on a LIVE grant of an Exchange detail; its missing member is null when the caller does not hold admin.tenant.actor.roles.read.
      Returns:
      operationPermissions

    • setOperationPermissions

      public void setOperationPermissions(@Nullable ExchangeOperationPermissions operationPermissions)

    • rateLimitPerMinute

      public ExchangeGrantSummary rateLimitPerMinute(@Nullable Integer rateLimitPerMinute)

    • getRateLimitPerMinute

      @Nullable public Integer getRateLimitPerMinute()
      Per-minute ceiling of the pinned version; 0 = fully blocked, null when none or when the grant has no Constraint Policy
      Returns:
      rateLimitPerMinute

    • setRateLimitPerMinute

      public void setRateLimitPerMinute(@Nullable Integer rateLimitPerMinute)

    • revokeOnUse

      public ExchangeGrantSummary revokeOnUse(@Nullable Boolean revokeOnUse)

    • getRevokeOnUse

      @Nullable public Boolean getRevokeOnUse()
      Single use: the first admitted invocation consumes the grant. null when the grant has no Constraint Policy
      Returns:
      revokeOnUse

    • setRevokeOnUse

      public void setRevokeOnUse(@Nullable Boolean revokeOnUse)

    • scheduleEnd

      public ExchangeGrantSummary scheduleEnd(@Nullable String scheduleEnd)

    • getScheduleEnd

      @Nullable public String getScheduleEnd()
      End of the pinned version's daily window, HH:mm, exclusive (earlier than the start for an overnight window); null when it has no schedule
      Returns:
      scheduleEnd

    • setScheduleEnd

      public void setScheduleEnd(@Nullable String scheduleEnd)

    • scheduleStart

      public ExchangeGrantSummary scheduleStart(@Nullable String scheduleStart)

    • getScheduleStart

      @Nullable public String getScheduleStart()
      Start of the pinned version's daily window, HH:mm, inclusive, in the schedule time zone; null when it has no schedule
      Returns:
      scheduleStart

    • setScheduleStart

      public void setScheduleStart(@Nullable String scheduleStart)

    • scheduleWeekdays

      public ExchangeGrantSummary scheduleWeekdays(@Nullable List<Integer> scheduleWeekdays)

    • addScheduleWeekdaysItem

      public ExchangeGrantSummary addScheduleWeekdaysItem(Integer scheduleWeekdaysItem)

    • getScheduleWeekdays

      @Nullable public List<Integer> getScheduleWeekdays()
      ISO weekdays (1 = Monday to 7 = Sunday) on which the pinned version's daily window opens, ascending; null when it has no schedule
      Returns:
      scheduleWeekdays

    • setScheduleWeekdays

      public void setScheduleWeekdays(@Nullable List<Integer> scheduleWeekdays)

    • status

      public ExchangeGrantSummary status(@Nullable ExchangeGrantSummary.StatusEnum status)

    • getStatus

      @Nullable public ExchangeGrantSummary.StatusEnum getStatus()
      LIVE: the grant exists and is governed by the Exchange's lifecycle. CONSUMED: its single use was taken or its maxUsage reached. REVOKED: it was removed, or ended with the Exchange.
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable ExchangeGrantSummary.StatusEnum status)

    • validFrom

      public ExchangeGrantSummary validFrom(@Nullable OffsetDateTime validFrom)

    • getValidFrom

      @Nullable public OffsetDateTime getValidFrom()
      Start of the pinned version's validity window, inclusive; null when unbounded or when the grant has no Constraint Policy
      Returns:
      validFrom

    • setValidFrom

      public void setValidFrom(@Nullable OffsetDateTime validFrom)

    • validUntil

      public ExchangeGrantSummary validUntil(@Nullable OffsetDateTime validUntil)

    • getValidUntil

      @Nullable public OffsetDateTime getValidUntil()
      End of the pinned version's validity window, exclusive; null when unbounded or when the grant has no Constraint Policy
      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 ExchangeGrantSummary

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

    • fromJson

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

    • toJson

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