Class ConstraintPolicyResponse
java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ConstraintPolicyResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.23.0")
public class ConstraintPolicyResponse
extends Object
Usage restrictions attached to Capability Grants. rateLimitPerMinute=0 means fully blocked (emergency freeze); null means no rate limit. The policy is a template: every write is an immutable version, and a grant enforces the version it is pinned to: the version current when it was issued, until the grant is re-pinned to another version. An edit therefore applies to grants issued afterwards and to grants re-pinned to the new version.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddScheduleWeekdaysItem(Integer scheduleWeekdaysItem) createdAt(OffsetDateTime createdAt) description(String description) booleanstatic ConstraintPolicyResponseCreate an instance of ConstraintPolicyResponse given an JSON stringGet createdAtGet descriptiongetId()Get idTotal invocation ceiling per grant; null = unlimited.getName()Get nameGet rateLimitPerMinuteGet revokeOnUseEnd of the current version's daily window, HH:mm, exclusive; null when it has no schedule.Start of the current version's daily window, HH:mm, inclusive; null when it has no schedule.The time zone in which the schedule is evaluated: the platform setting authorization.schedule.timezone, an IANA region zone or UTC.ISO weekdays (1 = Monday .. 7 = Sunday) of the current version's schedule, ascending; null when the current version has no schedule.Get tenantIdGet updatedAtGet validFromGet validUntilThe policy's current version.inthashCode()rateLimitPerMinute(Integer rateLimitPerMinute) revokeOnUse(Boolean revokeOnUse) scheduleEnd(String scheduleEnd) scheduleStart(String scheduleStart) scheduleTimeZone(String scheduleTimeZone) scheduleWeekdays(List<Integer> scheduleWeekdays) voidsetCreatedAt(OffsetDateTime createdAt) voidsetDescription(String description) voidvoidsetMaxUsage(Long maxUsage) voidvoidsetRateLimitPerMinute(Integer rateLimitPerMinute) voidsetRevokeOnUse(Boolean revokeOnUse) voidsetScheduleEnd(String scheduleEnd) voidsetScheduleStart(String scheduleStart) voidsetScheduleTimeZone(String scheduleTimeZone) voidsetScheduleWeekdays(List<Integer> scheduleWeekdays) voidsetTenantId(UUID tenantId) voidsetUpdatedAt(OffsetDateTime updatedAt) voidsetValidFrom(OffsetDateTime validFrom) voidsetValidUntil(OffsetDateTime validUntil) voidsetVersion(Integer version) toJson()Convert an instance of ConstraintPolicyResponse to an JSON stringtoString()updatedAt(OffsetDateTime updatedAt) 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.validFrom(OffsetDateTime validFrom) validUntil(OffsetDateTime validUntil)
-
Field Details
-
SERIALIZED_NAME_CREATED_AT
- See Also:
-
SERIALIZED_NAME_DESCRIPTION
- See Also:
-
SERIALIZED_NAME_ID
- See Also:
-
SERIALIZED_NAME_MAX_USAGE
- See Also:
-
SERIALIZED_NAME_NAME
- See Also:
-
SERIALIZED_NAME_RATE_LIMIT_PER_MINUTE
- See Also:
-
SERIALIZED_NAME_REVOKE_ON_USE
- See Also:
-
SERIALIZED_NAME_SCHEDULE_END
- See Also:
-
SERIALIZED_NAME_SCHEDULE_START
- See Also:
-
SERIALIZED_NAME_SCHEDULE_TIME_ZONE
- See Also:
-
SERIALIZED_NAME_SCHEDULE_WEEKDAYS
- See Also:
-
SERIALIZED_NAME_TENANT_ID
- See Also:
-
SERIALIZED_NAME_UPDATED_AT
- See Also:
-
SERIALIZED_NAME_VALID_FROM
- See Also:
-
SERIALIZED_NAME_VALID_UNTIL
- See Also:
-
SERIALIZED_NAME_VERSION
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
ConstraintPolicyResponse
public ConstraintPolicyResponse()
-
-
Method Details
-
createdAt
-
getCreatedAt
Get createdAt- Returns:
- createdAt
-
setCreatedAt
-
description
-
getDescription
Get description- Returns:
- description
-
setDescription
-
id
-
getId
Get id- Returns:
- id
-
setId
-
maxUsage
-
getMaxUsage
Total invocation ceiling per grant; null = unlimited. Consumption is counted per grant by the cryptographic service and is not published on this resource.- Returns:
- maxUsage
-
setMaxUsage
-
name
-
getName
Get name- Returns:
- name
-
setName
-
rateLimitPerMinute
-
getRateLimitPerMinute
Get rateLimitPerMinute- Returns:
- rateLimitPerMinute
-
setRateLimitPerMinute
-
revokeOnUse
-
getRevokeOnUse
Get revokeOnUse- Returns:
- revokeOnUse
-
setRevokeOnUse
-
scheduleEnd
-
getScheduleEnd
End of the current version's daily window, HH:mm, exclusive; null when it has no schedule.- Returns:
- scheduleEnd
-
setScheduleEnd
-
scheduleStart
-
getScheduleStart
Start of the current version's daily window, HH:mm, inclusive; null when it has no schedule.- Returns:
- scheduleStart
-
setScheduleStart
-
scheduleTimeZone
-
getScheduleTimeZone
The time zone in which the schedule is evaluated: the platform setting authorization.schedule.timezone, an IANA region zone or UTC. One platform value governs every schedule.- Returns:
- scheduleTimeZone
-
setScheduleTimeZone
-
scheduleWeekdays
-
addScheduleWeekdaysItem
-
getScheduleWeekdays
ISO weekdays (1 = Monday .. 7 = Sunday) of the current version's schedule, ascending; null when the current version has no schedule.- Returns:
- scheduleWeekdays
-
setScheduleWeekdays
-
tenantId
-
getTenantId
Get tenantId- Returns:
- tenantId
-
setTenantId
-
updatedAt
-
getUpdatedAt
Get updatedAt- Returns:
- updatedAt
-
setUpdatedAt
-
validFrom
-
getValidFrom
Get validFrom- Returns:
- validFrom
-
setValidFrom
-
validUntil
-
getValidUntil
Get validUntil- Returns:
- validUntil
-
setValidUntil
-
version
-
getVersion
The policy's current version. Create writes version 1 and every edit writes the next one; a grant issued now pins this version and keeps its limits after later edits.- 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 ConstraintPolicyResponse
-
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 ConstraintPolicyResponse
-
fromJson
Create an instance of ConstraintPolicyResponse given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of ConstraintPolicyResponse
- Throws:
IOException- if the JSON string is invalid with respect to ConstraintPolicyResponse
-
toJson
Convert an instance of ConstraintPolicyResponse to an JSON string- Returns:
- JSON string
-