Package dev.cachly.api.model

Class Instance

java.lang.Object
dev.cachly.api.model.Instance
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-04-17T00:43:25.074268745Z[Etc/UTC]", comments="Generator version: 7.5.0") public class Instance extends Object
Instance

  • Field Details

  • Constructor Details

    • Instance

      public Instance()

  • Method Details

    • id

      public Instance id(UUID id)

    • getId

      @Nullable public UUID getId()
      Get id
      Returns:
      id

    • setId

      public void setId(UUID id)

    • name

      public Instance name(String name)

    • getName

      @Nullable public String getName()
      Get name
      Returns:
      name

    • setName

      public void setName(String name)

    • tier

      public Instance tier(Instance.TierEnum tier)

    • getTier

      @Nullable public Instance.TierEnum getTier()
      Get tier
      Returns:
      tier

    • setTier

      public void setTier(Instance.TierEnum tier)

    • status

      public Instance status(Instance.StatusEnum status)

    • getStatus

      @Nullable public Instance.StatusEnum getStatus()
      Get status
      Returns:
      status

    • setStatus

      public void setStatus(Instance.StatusEnum status)

    • region

      public Instance region(String region)

    • getRegion

      @Nullable public String getRegion()
      Get region
      Returns:
      region

    • setRegion

      public void setRegion(String region)

    • engine

      public Instance engine(Instance.EngineEnum engine)

    • getEngine

      @Nullable public Instance.EngineEnum getEngine()
      Cache engine backing this instance
      Returns:
      engine

    • setEngine

      public void setEngine(Instance.EngineEnum engine)

    • clusterMode

      public Instance clusterMode(Boolean clusterMode)

    • getClusterMode

      @Nullable public Boolean getClusterMode()
      Whether the instance runs in Valkey Cluster mode (automatic sharding)
      Returns:
      clusterMode

    • setClusterMode

      public void setClusterMode(Boolean clusterMode)

    • host

      public Instance host(String host)

    • getHost

      @Nullable public String getHost()
      Get host
      Returns:
      host

    • setHost

      public void setHost(String host)

    • port

      public Instance port(Integer port)

    • getPort

      @Nullable public Integer getPort()
      Get port
      Returns:
      port

    • setPort

      public void setPort(Integer port)

    • memoryMb

      public Instance memoryMb(Integer memoryMb)

    • getMemoryMb

      @Nullable public Integer getMemoryMb()
      Get memoryMb
      Returns:
      memoryMb

    • setMemoryMb

      public void setMemoryMb(Integer memoryMb)

    • encryptionAtRest

      public Instance encryptionAtRest(Boolean encryptionAtRest)

    • getEncryptionAtRest

      @Nullable public Boolean getEncryptionAtRest()
      Get encryptionAtRest
      Returns:
      encryptionAtRest

    • setEncryptionAtRest

      public void setEncryptionAtRest(Boolean encryptionAtRest)

    • byoKeySet

      public Instance byoKeySet(Boolean byoKeySet)

    • getByoKeySet

      @Nullable public Boolean getByoKeySet()
      Whether the customer has set a BYOK (Bring Your Own Key) encryption key
      Returns:
      byoKeySet

    • setByoKeySet

      public void setByoKeySet(Boolean byoKeySet)

    • customDomain

      public Instance customDomain(String customDomain)

    • getCustomDomain

      @Nullable public String getCustomDomain()
      Customer's custom CNAME (e.g. cache.example.com)
      Returns:
      customDomain

    • setCustomDomain

      public void setCustomDomain(String customDomain)

    • customDomainVerified

      public Instance customDomainVerified(Boolean customDomainVerified)

    • getCustomDomainVerified

      @Nullable public Boolean getCustomDomainVerified()
      Whether the custom domain's DNS TXT record has been verified
      Returns:
      customDomainVerified

    • setCustomDomainVerified

      public void setCustomDomainVerified(Boolean customDomainVerified)

    • vectorToken

      public Instance vectorToken(UUID vectorToken)

    • getVectorToken

      @Nullable public UUID getVectorToken()
      Used for CACHLY_VECTOR_URL – authenticate semantic cache API calls
      Returns:
      vectorToken

    • setVectorToken

      public void setVectorToken(UUID vectorToken)

    • webhookUrl

      public Instance webhookUrl(URI webhookUrl)

    • getWebhookUrl

      @Nullable public URI getWebhookUrl()
      HTTPS endpoint receiving real-time cache events (hits, near-misses, threshold changes)
      Returns:
      webhookUrl

    • setWebhookUrl

      public void setWebhookUrl(URI webhookUrl)

    • createdAt

      public Instance createdAt(OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Get createdAt
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(OffsetDateTime createdAt)

    • updatedAt

      public Instance updatedAt(OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Get updatedAt
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(OffsetDateTime updatedAt)

    • equals

      public boolean equals(Object o)
      Return true if this Instance object is equal to o.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string