Class UpdateGatewayRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ecs.model.EcsRequest
software.amazon.awssdk.services.ecs.model.UpdateGatewayRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateGatewayRequest.Builder,UpdateGatewayRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateGatewayRequest extends EcsRequest implements ToCopyableBuilder<UpdateGatewayRequest.Builder,UpdateGatewayRequest>

  • Method Details

    • gateway

      public final String gateway()

      The name or Amazon Resource Name (ARN) of the gateway to update.

      Returns:
      The name or Amazon Resource Name (ARN) of the gateway to update.

    • infrastructureRoleArn

      public final String infrastructureRoleArn()

      The Amazon Resource Name (ARN) of the IAM role that the gateway assumes to manage infrastructure on your behalf.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that the gateway assumes to manage infrastructure on your behalf.

    • deletionProtection

      public final Boolean deletionProtection()

      Specifies whether to enable deletion protection for the gateway. When enabled, the gateway can't be deleted.

      Returns:
      Specifies whether to enable deletion protection for the gateway. When enabled, the gateway can't be deleted.

    • configuration

      public final UpdateGatewayConfiguration configuration()

      The updated type-specific configuration for the gateway. The configuration variant must match the gateway's existing type, and only mutable fields can be changed.

      Returns:
      The updated type-specific configuration for the gateway. The configuration variant must match the gateway's existing type, and only mutable fields can be changed.

    • propagateTags

      public final PropagateGatewayTags propagateTags()

      Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages. If you don't specify a value, the gateway's existing setting is unchanged.

      If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateGatewayTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().

      Returns:
      Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages. If you don't specify a value, the gateway's existing setting is unchanged.
      See Also:

    • propagateTagsAsString

      public final String propagateTagsAsString()

      Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages. If you don't specify a value, the gateway's existing setting is unchanged.

      If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateGatewayTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().

      Returns:
      Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages. If you don't specify a value, the gateway's existing setting is unchanged.
      See Also:

    • toBuilder

      public UpdateGatewayRequest.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<UpdateGatewayRequest.Builder,UpdateGatewayRequest>
      Specified by:
      toBuilder in class EcsRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateGatewayRequest.Builder builder()

    • serializableBuilderClass

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