Class Gateway

java.lang.Object
software.amazon.awssdk.services.ecs.model.Gateway
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Gateway.Builder,Gateway>
@Generated("software.amazon.awssdk:codegen") public final class Gateway extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Gateway.Builder,Gateway>

The details of a gateway, including its configuration, status, and the infrastructure settings for its type.

See Also:

  • Method Details

    • gatewayArn

      public final String gatewayArn()

      The Amazon Resource Name (ARN) of the gateway.

      Returns:
      The Amazon Resource Name (ARN) of the gateway.

    • name

      public final String name()

      The name of the gateway.

      Returns:
      The name of the gateway.

    • status

      public final GatewayStatus status()

      The status of the gateway.

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

      Returns:
      The status of the gateway.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the gateway.

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

      Returns:
      The status of the gateway.
      See Also:

    • statusReason

      public final String statusReason()

      A human-readable explanation of the current status. This value is populated when the gateway is in a failure state, such as UPDATE_FAILED.

      Returns:
      A human-readable explanation of the current status. This value is populated when the gateway is in a failure state, such as UPDATE_FAILED.

    • hasFailures

      public final boolean hasFailures()
      For responses, this returns true if the service returned a value for the Failures 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.

    • failures

      public final List<GatewayResourceFailure> failures()

      The per-resource failure details for asynchronous gateway processes, such as an UpdateGateway operation that couldn't update every load balancer.

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

      Returns:
      The per-resource failure details for asynchronous gateway processes, such as an UpdateGateway operation that couldn't update every load balancer.

    • infrastructureRoleArn

      public final String infrastructureRoleArn()

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

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

    • deletionProtection

      public final Boolean deletionProtection()

      Specifies whether deletion protection is enabled for the gateway.

      Returns:
      Specifies whether deletion protection is enabled for the gateway.

    • configuration

      public final DescribeGatewayConfiguration configuration()

      The type-specific configuration for the gateway.

      Returns:
      The type-specific configuration for the gateway.

    • accessType

      public final AccessType accessType()

      Specifies whether the gateway is publicly accessible (PUBLIC) or private (PRIVATE). The gateway derives this value from its scheme when you create the gateway, and the value is immutable.

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

      Returns:
      Specifies whether the gateway is publicly accessible (PUBLIC) or private ( PRIVATE). The gateway derives this value from its scheme when you create the gateway, and the value is immutable.
      See Also:

    • accessTypeAsString

      public final String accessTypeAsString()

      Specifies whether the gateway is publicly accessible (PUBLIC) or private (PRIVATE). The gateway derives this value from its scheme when you create the gateway, and the value is immutable.

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

      Returns:
      Specifies whether the gateway is publicly accessible (PUBLIC) or private ( PRIVATE). The gateway derives this value from its scheme when you create the gateway, and the value is immutable.
      See Also:

    • propagateTags

      public final PropagateGatewayTags propagateTags()

      Specifies whether the gateway propagates its tags to the infrastructure it manages.

      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 the gateway propagates its tags to the infrastructure it manages.
      See Also:

    • propagateTagsAsString

      public final String propagateTagsAsString()

      Specifies whether the gateway propagates its tags to the infrastructure it manages.

      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 the gateway propagates its tags to the infrastructure it manages.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The metadata applied to the gateway. Each tag consists of a key and an optional value.

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

      Returns:
      The metadata applied to the gateway. Each tag consists of a key and an optional value.

    • createdAt

      public final Instant createdAt()

      The Unix timestamp for the time when the gateway was created.

      Returns:
      The Unix timestamp for the time when the gateway was created.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp for the time when the gateway was last updated.

      Returns:
      The Unix timestamp for the time when the gateway was last updated.

    • toBuilder

      public Gateway.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<Gateway.Builder,Gateway>
      Returns:
      a builder for type T

    • builder

      public static Gateway.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Gateway.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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