Class UpdateKxClusterCodeConfigurationRequest

    • Method Detail

      • environmentId

        public final String environmentId()

        A unique identifier of the kdb environment.

        Returns:
        A unique identifier of the kdb environment.
      • clusterName

        public final String clusterName()

        The name of the cluster.

        Returns:
        The name of the cluster.
      • 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.
      • code

        public final CodeConfiguration code()
        Returns the value of the Code property for this object.
        Returns:
        The value of the Code property for this object.
      • initializationScript

        public final String initializationScript()

        Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

        You cannot update this parameter for a NO_RESTART deployment.

        Returns:
        Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

        You cannot update this parameter for a NO_RESTART deployment.

      • hasCommandLineArguments

        public final boolean hasCommandLineArguments()
        For responses, this returns true if the service returned a value for the CommandLineArguments 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.
      • commandLineArguments

        public final List<KxCommandLineArgument> commandLineArguments()

        Specifies the key-value pairs to make them available inside the cluster.

        You cannot update this parameter for a NO_RESTART deployment.

        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 hasCommandLineArguments() method.

        Returns:
        Specifies the key-value pairs to make them available inside the cluster.

        You cannot update this parameter for a NO_RESTART deployment.

      • deploymentConfiguration

        public final KxClusterCodeDeploymentConfiguration deploymentConfiguration()

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

        Returns:
        The configuration that allows you to choose how you want to update the code 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