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

Class ListInstalledComponentsRequest

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.ListInstalledComponentsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListInstalledComponentsRequest.Builder,ListInstalledComponentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListInstalledComponentsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListInstalledComponentsRequest.Builder	builder()
String	coreDeviceThingName()	The name of the core device.
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 ListInstalledComponentsRequest.Builder>	serializableBuilderClass()
ListInstalledComponentsRequest.Builder	toBuilder()
InstalledComponentTopologyFilter	topologyFilter()	The filter for the list of components.
String	topologyFilterAsString()	The filter for the list of components.
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

coreDeviceThingName

public final String coreDeviceThingName()

The name of the core device. This is also the name of the IoT thing.

Returns:

The name of the core device. This is also the name of the IoT thing.

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.

topologyFilter

public final InstalledComponentTopologyFilter topologyFilter()

The filter for the list of components. Choose from the following options:

• ALL – The list includes all components installed on the core device.

• ROOT – The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn't include components that the core device installs as dependencies of other components.

Default: ROOT

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

Returns:

The filter for the list of components. Choose from the following options:

• ALL – The list includes all components installed on the core device.

• ROOT – The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn't include components that the core device installs as dependencies of other components.

Default: ROOT

See Also:

InstalledComponentTopologyFilter

topologyFilterAsString

public final String topologyFilterAsString()

The filter for the list of components. Choose from the following options:

• ALL – The list includes all components installed on the core device.

• ROOT – The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn't include components that the core device installs as dependencies of other components.

Default: ROOT

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

Returns:

The filter for the list of components. Choose from the following options:

• ALL – The list includes all components installed on the core device.

• ROOT – The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn't include components that the core device installs as dependencies of other components.

Default: ROOT

See Also:

InstalledComponentTopologyFilter

toBuilder

public ListInstalledComponentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListInstalledComponentsRequest.Builder,ListInstalledComponentsRequest>

Specified by:

toBuilder in class GreengrassV2Request

builder

public static ListInstalledComponentsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListInstalledComponentsRequest.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