Class DescribeClusterResponse

    • Method Detail

      • arn

        public final String arn()
        The ARN of this Cluster. It is automatically assigned when the Cluster is created.
        Returns:
        The ARN of this Cluster. It is automatically assigned when the Cluster is created.
      • hasChannelIds

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

        public final List<String> channelIds()
        Returns the value of the ChannelIds property for this object.

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

        Returns:
        The value of the ChannelIds property for this object.
      • clusterTypeAsString

        public final String clusterTypeAsString()
        The hardware type for the Cluster

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

        Returns:
        The hardware type for the Cluster
        See Also:
        ClusterType
      • id

        public final String id()
        The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.
        Returns:
        The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.
      • instanceRoleArn

        public final String instanceRoleArn()
        The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.
        Returns:
        The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.
      • name

        public final String name()
        The name that you specified for the Cluster.
        Returns:
        The name that you specified for the Cluster.
      • networkSettings

        public final ClusterNetworkSettings networkSettings()
        Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.
        Returns:
        Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.
      • stateAsString

        public final String stateAsString()
        The current state of the Cluster.

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

        Returns:
        The current state of the Cluster.
        See Also:
        ClusterState
      • 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