Class ListInstancesRequest

    • Method Detail

      • clusterId

        public final String clusterId()

        The identifier of the cluster for which to list the instances.

        Returns:
        The identifier of the cluster for which to list the instances.
      • instanceGroupId

        public final String instanceGroupId()

        The identifier of the instance group for which to list the instances.

        Returns:
        The identifier of the instance group for which to list the instances.
      • instanceGroupTypes

        public final List<InstanceGroupType> instanceGroupTypes()

        The type of instance group for which to list the instances.

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

        Returns:
        The type of instance group for which to list the instances.
      • hasInstanceGroupTypes

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

        public final List<String> instanceGroupTypesAsStrings()

        The type of instance group for which to list the instances.

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

        Returns:
        The type of instance group for which to list the instances.
      • instanceFleetId

        public final String instanceFleetId()

        The unique identifier of the instance fleet.

        Returns:
        The unique identifier of the instance fleet.
      • instanceFleetTypeAsString

        public final String instanceFleetTypeAsString()

        The node type of the instance fleet. For example MASTER, CORE, or TASK.

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

        Returns:
        The node type of the instance fleet. For example MASTER, CORE, or TASK.
        See Also:
        InstanceFleetType
      • instanceStates

        public final List<InstanceState> instanceStates()

        A list of instance states that will filter the instances returned with this request.

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

        Returns:
        A list of instance states that will filter the instances returned with this request.
      • hasInstanceStates

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

        public final List<String> instanceStatesAsStrings()

        A list of instance states that will filter the instances returned with this request.

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

        Returns:
        A list of instance states that will filter the instances returned with this request.
      • marker

        public final String marker()

        The pagination token that indicates the next set of results to retrieve.

        Returns:
        The pagination token that indicates the next set of results to retrieve.
      • 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