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>

  • Method Details

    • 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 Servers Anywhere fleet, use a custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for example: us-west-2 or us-west-2-lax-1).

      Returns:
      The name of a location to retrieve compute resources for. For an Amazon GameLift Servers Anywhere fleet, use a custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for example: us-west-2 or us-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, computeStatus will return ListComputeInputStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeStatusAsString().

      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:

    • 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, computeStatus will return ListComputeInputStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeStatusAsString().

      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:

    • 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.

      Returns:
      The maximum number of results to return. Use this parameter with NextToken to 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListComputeRequest.Builder,ListComputeRequest>
      Specified by:
      toBuilder in class GameLiftRequest
      Returns:
      a builder for type T

    • builder

      public static ListComputeRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListComputeRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.