software.amazon.awssdk.services.gamelift.model

Class DescribeFleetCapacityRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeFleetCapacityRequest.Builder,DescribeFleetCapacityRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeFleetCapacityRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeFleetCapacityRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	fleetIds() A unique identifier for the fleet to retrieve capacity information for.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFleetIds() For responses, this returns true if the service returned a value for the FleetIds property.
int	hashCode()
Integer	limit() The maximum number of results to return.
String	nextToken() A token that indicates the start of the next sequential page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFleetCapacityRequest.Builder>	serializableBuilderClass()
DescribeFleetCapacityRequest.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

hasFleetIds

public final boolean hasFleetIds()

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

fleetIds

public final List<String> fleetIds()

A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.

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

Returns:

A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.

limit

public final Integer limit()

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

Returns:

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

nextToken

public final String nextToken()

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

Returns:

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

toBuilder

public DescribeFleetCapacityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeFleetCapacityRequest.Builder,DescribeFleetCapacityRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static DescribeFleetCapacityRequest.Builder builder()

serializableBuilderClass

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