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("software.amazon.awssdk:codegen") public final class UpdateFleetAttributesRequest extends GameLiftRequest implements ToCopyableBuilder<UpdateFleetAttributesRequest.Builder,UpdateFleetAttributesRequest>

  • Method Details

    • 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 game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions 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 game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions 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:

    • newGameSessionProtectionPolicyAsString

      public final String newGameSessionProtectionPolicyAsString()

      The game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions 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 game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions 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:

    • 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()

      Amazon GameLift Servers Anywhere configuration options.

      Returns:
      Amazon GameLift Servers Anywhere configuration options.

    • toBuilder

      public UpdateFleetAttributesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateFleetAttributesRequest.Builder,UpdateFleetAttributesRequest>
      Specified by:
      toBuilder in class GameLiftRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.