Interface LocationState.Builder

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

  • Method Details

    • allocatedCapacity

      LocationState.Builder allocatedCapacity(Integer allocatedCapacity)

      This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests.

      Parameters:
      allocatedCapacity - This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alwaysOnCapacity

      LocationState.Builder alwaysOnCapacity(Integer alwaysOnCapacity)

      The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.

      Parameters:
      alwaysOnCapacity - The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idleCapacity

      LocationState.Builder idleCapacity(Integer idleCapacity)

      This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's availability to respond to new stream requests, but not including on-demand capacity.

      Parameters:
      idleCapacity - This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's availability to respond to new stream requests, but not including on-demand capacity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationName

      LocationState.Builder locationName(String locationName)

      A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

      Parameters:
      locationName - A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onDemandCapacity

      LocationState.Builder onDemandCapacity(Integer onDemandCapacity)

      The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

      Parameters:
      onDemandCapacity - The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestedCapacity

      LocationState.Builder requestedCapacity(Integer requestedCapacity)

      This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group.

      Parameters:
      requestedCapacity - This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      LocationState.Builder status(String status)

      This value is set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

      Parameters:
      status - This value is set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

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

    • status

      LocationState.Builder status(StreamGroupLocationStatus status)

      This value is set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

      Parameters:
      status - This value is set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

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