Class UpdateKxClusterDatabasesRequest

    • Method Detail

      • environmentId

        public final String environmentId()

        The unique identifier of a kdb environment.

        Returns:
        The unique identifier of a kdb environment.
      • clusterName

        public final String clusterName()

        A unique name for the cluster that you want to modify.

        Returns:
        A unique name for the cluster that you want to modify.
      • clientToken

        public final String clientToken()

        A token that ensures idempotency. This token expires in 10 minutes.

        Returns:
        A token that ensures idempotency. This token expires in 10 minutes.
      • hasDatabases

        public final boolean hasDatabases()
        For responses, this returns true if the service returned a value for the Databases property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • databases

        public final List<KxDatabaseConfiguration> databases()

        The structure of databases mounted on the cluster.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDatabases() method.

        Returns:
        The structure of databases mounted on the cluster.
      • deploymentConfiguration

        public final KxDeploymentConfiguration deploymentConfiguration()

        The configuration that allows you to choose how you want to update the databases on a cluster.

        Returns:
        The configuration that allows you to choose how you want to update the databases on a cluster.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object