Class ParticipatingGateways

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

Specify the list of gateways to which you want to send downlink data traffic when the wireless device is running in class B or class C mode.

See Also:

  • Method Details

    • downlinkMode

      public final DownlinkMode downlinkMode()

      Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only the chosen gateways from the previous uplink message transmission.

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

      Returns:
      Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only the chosen gateways from the previous uplink message transmission.
      See Also:

    • downlinkModeAsString

      public final String downlinkModeAsString()

      Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only the chosen gateways from the previous uplink message transmission.

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

      Returns:
      Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only the chosen gateways from the previous uplink message transmission.
      See Also:

    • hasGatewayList

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

    • gatewayList

      public final List<GatewayListItem> gatewayList()

      The list of gateways that you want to use for sending the downlink data traffic.

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

      Returns:
      The list of gateways that you want to use for sending the downlink data traffic.

    • transmissionInterval

      public final Integer transmissionInterval()

      The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the payload to the next gateway.

      Returns:
      The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the payload to the next gateway.

    • toBuilder

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

    • builder

      public static ParticipatingGateways.Builder builder()

    • serializableBuilderClass

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