Class ListCoreDevicesRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListCoreDevicesRequest.Builder,ListCoreDevicesRequest>

@Generated("software.amazon.awssdk:codegen") public final class ListCoreDevicesRequest extends GreengrassV2Request implements ToCopyableBuilder<ListCoreDevicesRequest.Builder,ListCoreDevicesRequest>
  • Method Details

    • thingGroupArn

      public final String thingGroupArn()

      The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that have successfully deployed a deployment that targets the thing group. When you remove a core device from a thing group, the list continues to include that core device.

      Returns:
      The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that have successfully deployed a deployment that targets the thing group. When you remove a core device from a thing group, the list continues to include that core device.
    • status

      public final CoreDeviceStatus status()

      The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:

      • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

      • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

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

      Returns:
      The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:

      • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

      • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

      See Also:
    • statusAsString

      public final String statusAsString()

      The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:

      • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

      • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

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

      Returns:
      The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:

      • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

      • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

      See Also:
    • maxResults

      public final Integer maxResults()

      The maximum number of results to be returned per paginated request.

      Returns:
      The maximum number of results to be returned per paginated request.
    • nextToken

      public final String nextToken()

      The token to be used for the next set of paginated results.

      Returns:
      The token to be used for the next set of paginated results.
    • toBuilder

      public ListCoreDevicesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListCoreDevicesRequest.Builder,ListCoreDevicesRequest>
      Specified by:
      toBuilder in class GreengrassV2Request
      Returns:
      a builder for type T
    • builder

      public static ListCoreDevicesRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ListCoreDevicesRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.