Class ListComputeRequest
- 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.ListComputeRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListComputeRequest.Builder,ListComputeRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListComputeRequest extends GameLiftRequest implements ToCopyableBuilder<ListComputeRequest.Builder,ListComputeRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListComputeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListComputeRequest.Builderbuilder()ListComputeInputStatuscomputeStatus()The status of computes in a managed container fleet, based on the success of the latest update deployment.StringcomputeStatusAsString()The status of computes in a managed container fleet, based on the success of the latest update deployment.StringcontainerGroupDefinitionName()For computes in a managed container fleet, the name of the deployed container group definition.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfleetId()A unique identifier for the fleet to retrieve compute resources for.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Integerlimit()The maximum number of results to return.Stringlocation()The name of a location to retrieve compute resources for.StringnextToken()A token that indicates the start of the next sequential page of results.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ListComputeRequest.Builder>serializableBuilderClass()ListComputeRequest.BuildertoBuilder()StringtoString()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
-
fleetId
public final String fleetId()
A unique identifier for the fleet to retrieve compute resources for.
- Returns:
- A unique identifier for the fleet to retrieve compute resources for.
-
location
public final String location()
The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere fleet, use a custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for example:
us-west-2orus-west-2-lax-1).- Returns:
- The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere fleet, use a
custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for
example:
us-west-2orus-west-2-lax-1).
-
containerGroupDefinitionName
public final String containerGroupDefinitionName()
For computes in a managed container fleet, the name of the deployed container group definition.
- Returns:
- For computes in a managed container fleet, the name of the deployed container group definition.
-
computeStatus
public final ListComputeInputStatus computeStatus()
The status of computes in a managed container fleet, based on the success of the latest update deployment.
-
ACTIVE-- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions. -
IMPAIRED-- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.
If the service returns an enum value that is not available in the current SDK version,
computeStatuswill returnListComputeInputStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcomputeStatusAsString().- Returns:
- The status of computes in a managed container fleet, based on the success of the latest update
deployment.
-
ACTIVE-- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions. -
IMPAIRED-- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.
-
- See Also:
ListComputeInputStatus
-
-
computeStatusAsString
public final String computeStatusAsString()
The status of computes in a managed container fleet, based on the success of the latest update deployment.
-
ACTIVE-- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions. -
IMPAIRED-- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.
If the service returns an enum value that is not available in the current SDK version,
computeStatuswill returnListComputeInputStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcomputeStatusAsString().- Returns:
- The status of computes in a managed container fleet, based on the success of the latest update
deployment.
-
ACTIVE-- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions. -
IMPAIRED-- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.
-
- See Also:
ListComputeInputStatus
-
-
limit
public final Integer limit()
The maximum number of results to return. Use this parameter with
NextTokento get results as a set of sequential pages.- Returns:
- The maximum number of results to return. Use this parameter with
NextTokento get results as a set of sequential pages.
-
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.
- 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.
-
toBuilder
public ListComputeRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListComputeRequest.Builder,ListComputeRequest>- Specified by:
toBuilderin classGameLiftRequest
-
builder
public static ListComputeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListComputeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-