Package software.amazon.awssdk.services.lightsail.model

Class GetInstancesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lightsail.model.LightsailResponse

software.amazon.awssdk.services.lightsail.model.GetInstancesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetInstancesResponse.Builder,GetInstancesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetInstancesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetInstancesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstances()	For responses, this returns true if the service returned a value for the Instances property.
List<Instance>	instances()	An array of key-value pairs containing information about your instances.
String	nextPageToken()	The token to advance to the next page of results from your request.
List<SdkField<?>>	sdkFields()
static Class<? extends GetInstancesResponse.Builder>	serializableBuilderClass()
GetInstancesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.lightsail.model.LightsailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasInstances

public final boolean hasInstances()

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

instances

public final List<Instance> instances()

An array of key-value pairs containing information about your instances.

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

Returns:

An array of key-value pairs containing information about your instances.

nextPageToken

public final String nextPageToken()

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.

Returns:

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.

toBuilder

public GetInstancesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetInstancesResponse.Builder,GetInstancesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetInstancesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetInstancesResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo