Class DescribeContainerGroupPortMappingsRequest

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.DescribeContainerGroupPortMappingsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeContainerGroupPortMappingsRequest.Builder,DescribeContainerGroupPortMappingsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeContainerGroupPortMappingsRequest extends GameLiftRequest implements ToCopyableBuilder<DescribeContainerGroupPortMappingsRequest.Builder,DescribeContainerGroupPortMappingsRequest>

  • Method Details

    • fleetId

      public final String fleetId()

      A unique identifier for the container fleet. You can use either the fleet ID or ARN value.

      Returns:
      A unique identifier for the container fleet. You can use either the fleet ID or ARN value.

    • containerGroupType

      public final ContainerGroupType containerGroupType()

      The type of container group to retrieve port mappings for.

      • GAME_SERVER -- Get port mappings for a game server container group.

      • PER_INSTANCE -- Get port mappings for a per-instance container group.

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

      Returns:
      The type of container group to retrieve port mappings for.

      • GAME_SERVER -- Get port mappings for a game server container group.

      • PER_INSTANCE -- Get port mappings for a per-instance container group.

      See Also:

    • containerGroupTypeAsString

      public final String containerGroupTypeAsString()

      The type of container group to retrieve port mappings for.

      • GAME_SERVER -- Get port mappings for a game server container group.

      • PER_INSTANCE -- Get port mappings for a per-instance container group.

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

      Returns:
      The type of container group to retrieve port mappings for.

      • GAME_SERVER -- Get port mappings for a game server container group.

      • PER_INSTANCE -- Get port mappings for a per-instance container group.

      See Also:

    • computeName

      public final String computeName()

      A unique identifier for the compute resource for which to retrieve port mappings. For a container fleet, a compute represents a game server container group running on a fleet instance. You can use either the compute name or ARN value.

      When ContainerGroupType is GAME_SERVER, this parameter is required.

      When ContainerGroupType is PER_INSTANCE, do not provide this parameter. If you provide a compute name with PER_INSTANCE, the request fails with an InvalidRequestException.

      Returns:
      A unique identifier for the compute resource for which to retrieve port mappings. For a container fleet, a compute represents a game server container group running on a fleet instance. You can use either the compute name or ARN value.

      When ContainerGroupType is GAME_SERVER, this parameter is required.

      When ContainerGroupType is PER_INSTANCE, do not provide this parameter. If you provide a compute name with PER_INSTANCE, the request fails with an InvalidRequestException.

    • instanceId

      public final String instanceId()

      A unique identifier for the fleet instance to retrieve port mappings for.

      When ContainerGroupType is PER_INSTANCE, this parameter is required.

      When ContainerGroupType is GAME_SERVER, this parameter is optional. If you provide an instance ID, it must match the instance that's running the specified compute. If the instance ID doesn't match, the request fails with an InvalidRequestException.

      Returns:
      A unique identifier for the fleet instance to retrieve port mappings for.

      When ContainerGroupType is PER_INSTANCE, this parameter is required.

      When ContainerGroupType is GAME_SERVER, this parameter is optional. If you provide an instance ID, it must match the instance that's running the specified compute. If the instance ID doesn't match, the request fails with an InvalidRequestException.

    • containerName

      public final String containerName()

      A container name to filter the results. When provided, the operation returns port mappings for the specified container only. If no container with the specified name exists in the container group, the request fails with a NotFoundException.

      If not provided, the operation returns port mappings for all containers in the container group.

      Returns:
      A container name to filter the results. When provided, the operation returns port mappings for the specified container only. If no container with the specified name exists in the container group, the request fails with a NotFoundException.

      If not provided, the operation returns port mappings for all containers in the container group.

    • toBuilder

      public DescribeContainerGroupPortMappingsRequest.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<DescribeContainerGroupPortMappingsRequest.Builder,DescribeContainerGroupPortMappingsRequest>
      Specified by:
      toBuilder in class GameLiftRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeContainerGroupPortMappingsRequest.Builder builder()

    • serializableBuilderClass

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