Interface DescribeContainerGroupPortMappingsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeContainerGroupPortMappingsRequest.Builder,DescribeContainerGroupPortMappingsRequest>, GameLiftRequest.Builder, SdkBuilder<DescribeContainerGroupPortMappingsRequest.Builder,DescribeContainerGroupPortMappingsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeContainerGroupPortMappingsRequest
@Mutable @NotThreadSafe public static interface DescribeContainerGroupPortMappingsRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<DescribeContainerGroupPortMappingsRequest.Builder,DescribeContainerGroupPortMappingsRequest>

  • Method Details

    • fleetId

      DescribeContainerGroupPortMappingsRequest.Builder fleetId(String fleetId)

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

      Parameters:
      fleetId - A unique identifier for the container fleet. You can use either the fleet ID or ARN value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerGroupType

      DescribeContainerGroupPortMappingsRequest.Builder containerGroupType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • containerGroupType

      DescribeContainerGroupPortMappingsRequest.Builder containerGroupType(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • computeName

      DescribeContainerGroupPortMappingsRequest.Builder computeName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • instanceId

      DescribeContainerGroupPortMappingsRequest.Builder instanceId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • containerName

      DescribeContainerGroupPortMappingsRequest.Builder containerName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeContainerGroupPortMappingsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeContainerGroupPortMappingsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.