Class DescribeContainerGroupPortMappingsResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.gamelift.model.GameLiftResponse
software.amazon.awssdk.services.gamelift.model.DescribeContainerGroupPortMappingsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeContainerGroupPortMappingsResponse.Builder,DescribeContainerGroupPortMappingsResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeContainerGroupPortMappingsResponse extends GameLiftResponse implements ToCopyableBuilder<DescribeContainerGroupPortMappingsResponse.Builder,DescribeContainerGroupPortMappingsResponse>

  • Method Details

    • fleetId

      public final String fleetId()

      A unique identifier for the container fleet.

      Returns:
      A unique identifier for the container fleet.

    • location

      public final String location()

      The location of the fleet instance, expressed as an Amazon Web Services Region code, such as us-west-2.

      Returns:
      The location of the fleet instance, expressed as an Amazon Web Services Region code, such as us-west-2.

    • containerGroupDefinitionArn

      public final String containerGroupDefinitionArn()

      The Amazon Resource Name (ARN) that is assigned to the container group definition. The ARN value also identifies the specific container group definition version in use.

      Returns:
      The Amazon Resource Name (ARN) that is assigned to the container group definition. The ARN value also identifies the specific container group definition version in use.

    • containerGroupType

      public final ContainerGroupType containerGroupType()

      The type of container group that was specified in the request. Valid values are GAME_SERVER or PER_INSTANCE.

      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 that was specified in the request. Valid values are GAME_SERVER or PER_INSTANCE.
      See Also:

    • containerGroupTypeAsString

      public final String containerGroupTypeAsString()

      The type of container group that was specified in the request. Valid values are GAME_SERVER or PER_INSTANCE.

      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 that was specified in the request. Valid values are GAME_SERVER or PER_INSTANCE.
      See Also:

    • computeName

      public final String computeName()

      A unique identifier for the compute resource running the game server container group. Returned when ContainerGroupType is GAME_SERVER.

      Returns:
      A unique identifier for the compute resource running the game server container group. Returned when ContainerGroupType is GAME_SERVER.

    • instanceId

      public final String instanceId()

      A unique identifier for the fleet instance. For GAME_SERVER requests, this is the instance running the specified compute. For PER_INSTANCE requests, this is the instance specified in the request.

      Returns:
      A unique identifier for the fleet instance. For GAME_SERVER requests, this is the instance running the specified compute. For PER_INSTANCE requests, this is the instance specified in the request.

    • hasContainerGroupPortMappings

      public final boolean hasContainerGroupPortMappings()
      For responses, this returns true if the service returned a value for the ContainerGroupPortMappings 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.

    • containerGroupPortMappings

      public final List<ContainerGroupPortMapping> containerGroupPortMappings()

      A list of ContainerGroupPortMapping objects that describe the port mappings for each container in the container group.

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

      Returns:
      A list of ContainerGroupPortMapping objects that describe the port mappings for each container in the container group.

    • toBuilder

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

    • builder

      public static DescribeContainerGroupPortMappingsResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeContainerGroupPortMappingsResponse.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)
      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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.