software.amazon.awssdk.services.migrationhubstrategy.model

Class ListApplicationComponentsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.migrationhubstrategy.model.MigrationHubStrategyRequest

software.amazon.awssdk.services.migrationhubstrategy.model.ListApplicationComponentsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListApplicationComponentsRequest.Builder,ListApplicationComponentsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListApplicationComponentsRequest
extends MigrationHubStrategyRequest
implements ToCopyableBuilder<ListApplicationComponentsRequest.Builder,ListApplicationComponentsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListApplicationComponentsRequest.Builder

Method Summary

Modifier and Type	Method and Description
ApplicationComponentCriteria	applicationComponentCriteria() Criteria for filtering the list of application components.
String	applicationComponentCriteriaAsString() Criteria for filtering the list of application components.
static ListApplicationComponentsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterValue() Specify the value based on the application component criteria type.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<Group>	groupIdFilter() The group ID specified in to filter on.
boolean	hasGroupIdFilter() For responses, this returns true if the service returned a value for the GroupIdFilter property.
int	hashCode()
Integer	maxResults() The maximum number of items to include in the response.
String	nextToken() The token from a previous call that you use to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListApplicationComponentsRequest.Builder>	serializableBuilderClass()
SortOrder	sort() Specifies whether to sort by ascending (ASC) or descending (DESC) order.
String	sortAsString() Specifies whether to sort by ascending (ASC) or descending (DESC) order.
ListApplicationComponentsRequest.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

applicationComponentCriteria

public final ApplicationComponentCriteria applicationComponentCriteria()

Criteria for filtering the list of application components.

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

Returns:

Criteria for filtering the list of application components.

See Also:

ApplicationComponentCriteria

applicationComponentCriteriaAsString

public final String applicationComponentCriteriaAsString()

Criteria for filtering the list of application components.

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

Returns:

Criteria for filtering the list of application components.

See Also:

ApplicationComponentCriteria

filterValue

public final String filterValue()

Specify the value based on the application component criteria type. For example, if applicationComponentCriteria is set to SERVER_ID and filterValue is set to server1, then ListApplicationComponents returns all the application components running on server1.

Returns:

Specify the value based on the application component criteria type. For example, if applicationComponentCriteria is set to SERVER_ID and filterValue is set to server1, then ListApplicationComponents returns all the application components running on server1.

hasGroupIdFilter

public final boolean hasGroupIdFilter()

For responses, this returns true if the service returned a value for the GroupIdFilter 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.

groupIdFilter

public final List<Group> groupIdFilter()

The group ID specified in to filter on.

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

Returns:

The group ID specified in to filter on.

maxResults

public final Integer maxResults()

The maximum number of items to include in the response. The maximum value is 100.

Returns:

The maximum number of items to include in the response. The maximum value is 100.

nextToken

public final String nextToken()

The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

Returns:

The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

sort

public final SortOrder sort()

Specifies whether to sort by ascending (ASC) or descending (DESC) order.

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

Returns:

Specifies whether to sort by ascending (ASC) or descending (DESC) order.

See Also:

SortOrder

sortAsString

public final String sortAsString()

Specifies whether to sort by ascending (ASC) or descending (DESC) order.

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

Returns:

Specifies whether to sort by ascending (ASC) or descending (DESC) order.

See Also:

SortOrder

toBuilder

public ListApplicationComponentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListApplicationComponentsRequest.Builder,ListApplicationComponentsRequest>

Specified by:

toBuilder in class MigrationHubStrategyRequest

builder

public static ListApplicationComponentsRequest.Builder builder()

serializableBuilderClass

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