Class Location

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

Information about an Direct Connect location.

See Also:

  • Method Details

    • locationCode

      public final String locationCode()

      The code for the location.

      Returns:
      The code for the location.

    • locationName

      public final String locationName()

      The name of the location. This includes the name of the colocation partner and the physical site of the building.

      Returns:
      The name of the location. This includes the name of the colocation partner and the physical site of the building.

    • region

      public final String region()

      The Amazon Web Services Region for the location.

      Returns:
      The Amazon Web Services Region for the location.

    • hasAvailablePortSpeeds

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

    • availablePortSpeeds

      public final List<String> availablePortSpeeds()

      The available port speeds for the location.

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

      Returns:
      The available port speeds for the location.

    • hasAvailableProviders

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

    • availableProviders

      public final List<String> availableProviders()

      The name of the service provider for the location.

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

      Returns:
      The name of the service provider for the location.

    • hasAvailableMacSecPortSpeeds

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

    • availableMacSecPortSpeeds

      public final List<String> availableMacSecPortSpeeds()

      The available MAC Security (MACsec) port speeds for the location.

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

      Returns:
      The available MAC Security (MACsec) port speeds for the location.

    • toBuilder

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

    • builder

      public static Location.Builder builder()

    • serializableBuilderClass

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