Class Gateway

java.lang.Object
software.amazon.awssdk.services.mediaconnect.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 settings for a gateway, including its networks.
See Also:

  • Method Details

    • hasEgressCidrBlocks

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

    • egressCidrBlocks

      public final List<String> egressCidrBlocks()
      The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

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

      Returns:
      The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

    • gatewayArn

      public final String gatewayArn()
      The Amazon Resource Name (ARN) of the gateway.
      Returns:
      The Amazon Resource Name (ARN) of the gateway.

    • hasGatewayMessages

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

    • gatewayMessages

      public final List<MessageDetail> gatewayMessages()
      Returns the value of the GatewayMessages property for this object.

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

      Returns:
      The value of the GatewayMessages property for this object.

    • gatewayState

      public final GatewayState gatewayState()
      The current status of the gateway.

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

      Returns:
      The current status of the gateway.
      See Also:

    • gatewayStateAsString

      public final String gatewayStateAsString()
      The current status of the gateway.

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

      Returns:
      The current status of the gateway.
      See Also:

    • name

      public final String name()
      The name of the gateway. This name can not be modified after the gateway is created.
      Returns:
      The name of the gateway. This name can not be modified after the gateway is created.

    • hasNetworks

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

    • networks

      public final List<GatewayNetwork> networks()
      The list of networks in the gateway.

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

      Returns:
      The list of networks in the gateway.

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