software.amazon.awssdk.services.gamelift.model

Class UpdateFleetAttributesRequest

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.UpdateFleetAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateFleetAttributesRequest.Builder,UpdateFleetAttributesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateFleetAttributesRequest
extends GameLiftRequest
implements ToCopyableBuilder<UpdateFleetAttributesRequest.Builder,UpdateFleetAttributesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateFleetAttributesRequest.Builder

Method Summary

Modifier and Type	Method and Description
AnywhereConfiguration	anywhereConfiguration() GameLift Anywhere configuration options.
static UpdateFleetAttributesRequest.Builder	builder()
String	description() A human-readable description of a fleet.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetId() A unique identifier for the fleet to update attribute metadata for.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricGroups() For responses, this returns true if the service returned a value for the MetricGroups property.
List<String>	metricGroups() The name of a metric group to add this fleet to.
String	name() A descriptive label that is associated with a fleet.
ProtectionPolicy	newGameSessionProtectionPolicy() The game session protection policy to apply to all new instances created in this fleet.
String	newGameSessionProtectionPolicyAsString() The game session protection policy to apply to all new instances created in this fleet.
ResourceCreationLimitPolicy	resourceCreationLimitPolicy() Policy settings that limit the number of game sessions an individual player can create over a span of time.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateFleetAttributesRequest.Builder>	serializableBuilderClass()
UpdateFleetAttributesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fleetId

public final String fleetId()

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Returns:

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

name

public final String name()

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Returns:

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

description

public final String description()

A human-readable description of a fleet.

Returns:

A human-readable description of a fleet.

newGameSessionProtectionPolicy

public final ProtectionPolicy newGameSessionProtectionPolicy()

The 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 newGameSessionProtectionPolicyAsString().

Returns:

The 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.

See Also:

ProtectionPolicy

newGameSessionProtectionPolicyAsString

public final String newGameSessionProtectionPolicyAsString()

The 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 newGameSessionProtectionPolicyAsString().

Returns:

The 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.

See Also:

ProtectionPolicy

resourceCreationLimitPolicy

public final ResourceCreationLimitPolicy resourceCreationLimitPolicy()

Policy settings that limit the number of game sessions an individual player can create over a span of time.

Returns:

Policy settings that limit the number of game sessions an individual player can create over a span of time.

hasMetricGroups

public final boolean hasMetricGroups()

For responses, this returns true if the service returned a value for the MetricGroups 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.

metricGroups

public final List<String> metricGroups()

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

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

Returns:

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

anywhereConfiguration

public final AnywhereConfiguration anywhereConfiguration()

GameLift Anywhere configuration options.

Returns:

GameLift Anywhere configuration options.

toBuilder

public UpdateFleetAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateFleetAttributesRequest.Builder,UpdateFleetAttributesRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static UpdateFleetAttributesRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo