UpdateFleetAttributesRequest (AWS Java SDK :: Services

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>

Represents the input for a request operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateFleetAttributesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateFleetAttributesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateFleetAttributesRequest.Builder`	`builder()`
`String`	`description()` Human-readable description of a fleet.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fleetId()` A unique identifier for a fleet to update attribute metadata for.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMetricGroups()` Returns true if the MetricGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`metricGroups()` Names of metric groups to include this fleet in.
`String`	`name()` A 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`	`newGameSessionProtectionPolicyAsString()` 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.
`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 String fleetId()
```
    A unique identifier for a fleet to update attribute metadata for. You can use either the fleet ID or ARN value.
    
    Returns:
    
    A unique identifier for a fleet to update attribute metadata for. You can use either the fleet ID or ARN value.
  - name
```
public 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 String description()
```
    Human-readable description of a fleet.
    
    Returns:
    
    Human-readable description of a fleet.
  - newGameSessionProtectionPolicy
```
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 newGameSessionProtectionPolicyAsString().
    Returns:
    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 String newGameSessionProtectionPolicyAsString()
```
    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:
    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 ResourceCreationLimitPolicy resourceCreationLimitPolicy()
```
    Policy that limits the number of game sessions an individual player can create over a span of time.
    
    Returns:
    
    Policy that limits the number of game sessions an individual player can create over a span of time.
  - hasMetricGroups
```
public boolean hasMetricGroups()
```
    Returns true if the MetricGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - metricGroups
```
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.
    
    You can use hasMetricGroups() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateFleetAttributesRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

fleetId

name

description

newGameSessionProtectionPolicy

newGameSessionProtectionPolicyAsString

resourceCreationLimitPolicy

hasMetricGroups

metricGroups

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields