@Generated(value="software.amazon.awssdk:codegen") public class UpdateFleetAttributesRequest extends GameLiftRequest implements ToCopyableBuilder<UpdateFleetAttributesRequest.Builder,UpdateFleetAttributesRequest>
Represents the input for a request action.
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateFleetAttributesRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static UpdateFleetAttributesRequest.Builder |
builder() |
String |
description()
Human-readable description of a fleet.
|
boolean |
equals(Object obj) |
String |
fleetId()
Unique identifier for a fleet to update attribute metadata for.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
List<String> |
metricGroups()
Names of metric groups to include this fleet in.
|
String |
name()
Descriptive label that is associated with a fleet.
|
ProtectionPolicy |
newGameSessionProtectionPolicy()
Game session protection policy to apply to all new instances created in this fleet.
|
String |
newGameSessionProtectionPolicyString()
Game session protection policy to apply to all new instances created in this fleet.
|
ResourceCreationLimitPolicy |
resourceCreationLimitPolicy()
Policy that limits the number of game sessions an individual player can create over a span of time.
|
static Class<? extends UpdateFleetAttributesRequest.Builder> |
serializableBuilderClass() |
UpdateFleetAttributesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String fleetId()
Unique identifier for a fleet to update attribute metadata for.
public String name()
Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
public String description()
Human-readable description of a fleet.
public ProtectionPolicy newGameSessionProtectionPolicy()
Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE
status, it cannot be terminated during
a scale-down event.
If the service returns an enum value that is not available in the current SDK version,
newGameSessionProtectionPolicy
will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from newGameSessionProtectionPolicyString()
.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE
status, it cannot be terminated
during a scale-down event.
ProtectionPolicy
public String newGameSessionProtectionPolicyString()
Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE
status, it cannot be terminated during
a scale-down event.
If the service returns an enum value that is not available in the current SDK version,
newGameSessionProtectionPolicy
will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from newGameSessionProtectionPolicyString()
.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE
status, it cannot be terminated
during a scale-down event.
ProtectionPolicy
public ResourceCreationLimitPolicy resourceCreationLimitPolicy()
Policy that limits the number of game sessions an individual player can create over a span of time.
public List<String> metricGroups()
Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public UpdateFleetAttributesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateFleetAttributesRequest.Builder,UpdateFleetAttributesRequest>
toBuilder
in class GameLiftRequest
public static UpdateFleetAttributesRequest.Builder builder()
public static Class<? extends UpdateFleetAttributesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.