software.amazon.awssdk.services.directconnect.model.Location Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of directconnect Show documentation
Show all versions of directconnect Show documentation
The AWS Java SDK for AWS Direct Connect module holds the client classes that are used for communicating
with AWS Direct
Connect Service
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.directconnect.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Information about an AWS Direct Connect location.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Location implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField LOCATION_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("locationCode").getter(getter(Location::locationCode)).setter(setter(Builder::locationCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("locationCode").build()).build();
private static final SdkField LOCATION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("locationName").getter(getter(Location::locationName)).setter(setter(Builder::locationName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("locationName").build()).build();
private static final SdkField REGION_FIELD = SdkField. builder(MarshallingType.STRING).memberName("region")
.getter(getter(Location::region)).setter(setter(Builder::region))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("region").build()).build();
private static final SdkField> AVAILABLE_PORT_SPEEDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("availablePortSpeeds")
.getter(getter(Location::availablePortSpeeds))
.setter(setter(Builder::availablePortSpeeds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("availablePortSpeeds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> AVAILABLE_PROVIDERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("availableProviders")
.getter(getter(Location::availableProviders))
.setter(setter(Builder::availableProviders))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("availableProviders").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LOCATION_CODE_FIELD,
LOCATION_NAME_FIELD, REGION_FIELD, AVAILABLE_PORT_SPEEDS_FIELD, AVAILABLE_PROVIDERS_FIELD));
private static final long serialVersionUID = 1L;
private final String locationCode;
private final String locationName;
private final String region;
private final List availablePortSpeeds;
private final List availableProviders;
private Location(BuilderImpl builder) {
this.locationCode = builder.locationCode;
this.locationName = builder.locationName;
this.region = builder.region;
this.availablePortSpeeds = builder.availablePortSpeeds;
this.availableProviders = builder.availableProviders;
}
/**
*
* The code for the location.
*
*
* @return The code for the location.
*/
public String locationCode() {
return locationCode;
}
/**
*
* The name of the location. This includes the name of the colocation partner and the physical site of the building.
*
*
* @return The name of the location. This includes the name of the colocation partner and the physical site of the
* building.
*/
public String locationName() {
return locationName;
}
/**
*
* The AWS Region for the location.
*
*
* @return The AWS Region for the location.
*/
public String region() {
return region;
}
/**
* Returns true if the AvailablePortSpeeds property was specified by the sender (it may be empty), or false if the
* sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public boolean hasAvailablePortSpeeds() {
return availablePortSpeeds != null && !(availablePortSpeeds instanceof SdkAutoConstructList);
}
/**
*
* The available port speeds for the location.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasAvailablePortSpeeds()} to see if a value was sent in this field.
*
*
* @return The available port speeds for the location.
*/
public List availablePortSpeeds() {
return availablePortSpeeds;
}
/**
* Returns true if the AvailableProviders property was specified by the sender (it may be empty), or false if the
* sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public boolean hasAvailableProviders() {
return availableProviders != null && !(availableProviders instanceof SdkAutoConstructList);
}
/**
*
* The name of the service provider for the location.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasAvailableProviders()} to see if a value was sent in this field.
*
*
* @return The name of the service provider for the location.
*/
public List availableProviders() {
return availableProviders;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(locationCode());
hashCode = 31 * hashCode + Objects.hashCode(locationName());
hashCode = 31 * hashCode + Objects.hashCode(region());
hashCode = 31 * hashCode + Objects.hashCode(availablePortSpeeds());
hashCode = 31 * hashCode + Objects.hashCode(availableProviders());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Location)) {
return false;
}
Location other = (Location) obj;
return Objects.equals(locationCode(), other.locationCode()) && Objects.equals(locationName(), other.locationName())
&& Objects.equals(region(), other.region()) && Objects.equals(availablePortSpeeds(), other.availablePortSpeeds())
&& Objects.equals(availableProviders(), other.availableProviders());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("Location").add("LocationCode", locationCode()).add("LocationName", locationName())
.add("Region", region()).add("AvailablePortSpeeds", availablePortSpeeds())
.add("AvailableProviders", availableProviders()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "locationCode":
return Optional.ofNullable(clazz.cast(locationCode()));
case "locationName":
return Optional.ofNullable(clazz.cast(locationName()));
case "region":
return Optional.ofNullable(clazz.cast(region()));
case "availablePortSpeeds":
return Optional.ofNullable(clazz.cast(availablePortSpeeds()));
case "availableProviders":
return Optional.ofNullable(clazz.cast(availableProviders()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Location) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The code for the location.
*
*
* @param locationCode
* The code for the location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder locationCode(String locationCode);
/**
*
* The name of the location. This includes the name of the colocation partner and the physical site of the
* building.
*
*
* @param locationName
* The name of the location. This includes the name of the colocation partner and the physical site of
* the building.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder locationName(String locationName);
/**
*
* The AWS Region for the location.
*
*
* @param region
* The AWS Region for the location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder region(String region);
/**
*
* The available port speeds for the location.
*
*
* @param availablePortSpeeds
* The available port speeds for the location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder availablePortSpeeds(Collection availablePortSpeeds);
/**
*
* The available port speeds for the location.
*
*
* @param availablePortSpeeds
* The available port speeds for the location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder availablePortSpeeds(String... availablePortSpeeds);
/**
*
* The name of the service provider for the location.
*
*
* @param availableProviders
* The name of the service provider for the location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder availableProviders(Collection availableProviders);
/**
*
* The name of the service provider for the location.
*
*
* @param availableProviders
* The name of the service provider for the location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder availableProviders(String... availableProviders);
}
static final class BuilderImpl implements Builder {
private String locationCode;
private String locationName;
private String region;
private List availablePortSpeeds = DefaultSdkAutoConstructList.getInstance();
private List availableProviders = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Location model) {
locationCode(model.locationCode);
locationName(model.locationName);
region(model.region);
availablePortSpeeds(model.availablePortSpeeds);
availableProviders(model.availableProviders);
}
public final String getLocationCode() {
return locationCode;
}
@Override
public final Builder locationCode(String locationCode) {
this.locationCode = locationCode;
return this;
}
public final void setLocationCode(String locationCode) {
this.locationCode = locationCode;
}
public final String getLocationName() {
return locationName;
}
@Override
public final Builder locationName(String locationName) {
this.locationName = locationName;
return this;
}
public final void setLocationName(String locationName) {
this.locationName = locationName;
}
public final String getRegion() {
return region;
}
@Override
public final Builder region(String region) {
this.region = region;
return this;
}
public final void setRegion(String region) {
this.region = region;
}
public final Collection getAvailablePortSpeeds() {
return availablePortSpeeds;
}
@Override
public final Builder availablePortSpeeds(Collection availablePortSpeeds) {
this.availablePortSpeeds = AvailablePortSpeedsCopier.copy(availablePortSpeeds);
return this;
}
@Override
@SafeVarargs
public final Builder availablePortSpeeds(String... availablePortSpeeds) {
availablePortSpeeds(Arrays.asList(availablePortSpeeds));
return this;
}
public final void setAvailablePortSpeeds(Collection availablePortSpeeds) {
this.availablePortSpeeds = AvailablePortSpeedsCopier.copy(availablePortSpeeds);
}
public final Collection getAvailableProviders() {
return availableProviders;
}
@Override
public final Builder availableProviders(Collection availableProviders) {
this.availableProviders = ProviderListCopier.copy(availableProviders);
return this;
}
@Override
@SafeVarargs
public final Builder availableProviders(String... availableProviders) {
availableProviders(Arrays.asList(availableProviders));
return this;
}
public final void setAvailableProviders(Collection availableProviders) {
this.availableProviders = ProviderListCopier.copy(availableProviders);
}
@Override
public Location build() {
return new Location(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy