software.amazon.awssdk.services.directconnect.model

Class Location

java.lang.Object

software.amazon.awssdk.services.directconnect.model.Location

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Location.Builder,Location>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Location.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	availableMacSecPortSpeeds() The available MAC Security (MACsec) port speeds for the location.
List<String>	availablePortSpeeds() The available port speeds for the location.
List<String>	availableProviders() The name of the service provider for the location.
static Location.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAvailableMacSecPortSpeeds() For responses, this returns true if the service returned a value for the AvailableMacSecPortSpeeds property.
boolean	hasAvailablePortSpeeds() For responses, this returns true if the service returned a value for the AvailablePortSpeeds property.
boolean	hasAvailableProviders() For responses, this returns true if the service returned a value for the AvailableProviders property.
int	hashCode()
String	locationCode() The code for the location.
String	locationName() The name of the location.
String	region() The Amazon Web Services Region for the location.
List<SdkField<?>>	sdkFields()
static Class<? extends Location.Builder>	serializableBuilderClass()
Location.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<Location.Builder,Location>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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