Package software.amazon.awssdk.services.greengrassv2.model

Class ListCoreDevicesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.greengrassv2.model.GreengrassV2Request

software.amazon.awssdk.services.greengrassv2.model.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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCoreDevicesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListCoreDevicesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results to be returned per paginated request.
String	nextToken()	The token to be used for the next set of paginated results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListCoreDevicesRequest.Builder>	serializableBuilderClass()
CoreDeviceStatus	status()	The core device status by which to filter.
String	statusAsString()	The core device status by which to filter.
String	thingGroupArn()	The ARN of the IoT thing group by which to filter.
ListCoreDevicesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

CoreDeviceStatus

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:

CoreDeviceStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCoreDevicesRequest.Builder,ListCoreDevicesRequest>

Specified by:

toBuilder in class GreengrassV2Request

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo