Package software.amazon.awssdk.services.codedeploy.model

Class ListOnPremisesInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codedeploy.model.CodeDeployRequest

software.amazon.awssdk.services.codedeploy.model.ListOnPremisesInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListOnPremisesInstancesRequest.Builder,ListOnPremisesInstancesRequest>

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

Represents the input of a ListOnPremisesInstances operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListOnPremisesInstancesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListOnPremisesInstancesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagFilters()	For responses, this returns true if the service returned a value for the TagFilters property.
String	nextToken()	An identifier returned from the previous list on-premises instances call.
RegistrationStatus	registrationStatus()	The registration status of the on-premises instances:
String	registrationStatusAsString()	The registration status of the on-premises instances:
List<SdkField<?>>	sdkFields()
static Class<? extends ListOnPremisesInstancesRequest.Builder>	serializableBuilderClass()
List<TagFilter>	tagFilters()	The on-premises instance tags that are used to restrict the on-premises instance names returned.
ListOnPremisesInstancesRequest.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

registrationStatus

public final RegistrationStatus registrationStatus()

The registration status of the on-premises instances:

• Deregistered: Include deregistered on-premises instances in the resulting list.

• Registered: Include registered on-premises instances in the resulting list.

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

Returns:

The registration status of the on-premises instances:

• Deregistered: Include deregistered on-premises instances in the resulting list.

• Registered: Include registered on-premises instances in the resulting list.

See Also:

RegistrationStatus

registrationStatusAsString

public final String registrationStatusAsString()

The registration status of the on-premises instances:

• Deregistered: Include deregistered on-premises instances in the resulting list.

• Registered: Include registered on-premises instances in the resulting list.

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

Returns:

The registration status of the on-premises instances:

• Deregistered: Include deregistered on-premises instances in the resulting list.

• Registered: Include registered on-premises instances in the resulting list.

See Also:

RegistrationStatus

hasTagFilters

public final boolean hasTagFilters()

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

tagFilters

public final List<TagFilter> tagFilters()

The on-premises instance tags that are used to restrict the on-premises instance names returned.

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

Returns:

The on-premises instance tags that are used to restrict the on-premises instance names returned.

nextToken

public final String nextToken()

An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.

Returns:

An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.

toBuilder

public ListOnPremisesInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListOnPremisesInstancesRequest.Builder,ListOnPremisesInstancesRequest>

Specified by:

toBuilder in class CodeDeployRequest

builder

public static ListOnPremisesInstancesRequest.Builder builder()

serializableBuilderClass

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