Class CreateClusterRequest

    • Method Detail

      • clusterName

        public final String clusterName()

        A name to identify the cluster. Example: MyCluster

        Returns:
        A name to identify the cluster. Example: MyCluster
      • scheduler

        public final SchedulerRequest scheduler()

        The cluster management and job scheduling software associated with the cluster.

        Returns:
        The cluster management and job scheduling software associated with the cluster.
      • size

        public final Size size()

        A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

        • SMALL: 32 compute nodes and 256 jobs

        • MEDIUM: 512 compute nodes and 8192 jobs

        • LARGE: 2048 compute nodes and 16,384 jobs

        If the service returns an enum value that is not available in the current SDK version, size will return Size.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sizeAsString().

        Returns:
        A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

        • SMALL: 32 compute nodes and 256 jobs

        • MEDIUM: 512 compute nodes and 8192 jobs

        • LARGE: 2048 compute nodes and 16,384 jobs

        See Also:
        Size
      • sizeAsString

        public final String sizeAsString()

        A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

        • SMALL: 32 compute nodes and 256 jobs

        • MEDIUM: 512 compute nodes and 8192 jobs

        • LARGE: 2048 compute nodes and 16,384 jobs

        If the service returns an enum value that is not available in the current SDK version, size will return Size.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sizeAsString().

        Returns:
        A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

        • SMALL: 32 compute nodes and 256 jobs

        • MEDIUM: 512 compute nodes and 8192 jobs

        • LARGE: 2048 compute nodes and 16,384 jobs

        See Also:
        Size
      • networking

        public final NetworkingRequest networking()

        The networking configuration used to set up the cluster's control plane.

        Returns:
        The networking configuration used to set up the cluster's control plane.
      • slurmConfiguration

        public final ClusterSlurmConfigurationRequest slurmConfiguration()

        Additional options related to the Slurm scheduler.

        Returns:
        Additional options related to the Slurm scheduler.
      • clientToken

        public final String clientToken()

        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

        Returns:
        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
      • hasTags

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

        public final Map<String,​String> tags()

        1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

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

        Returns:
        1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
      • 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