software.amazon.awssdk.services.networkmanager.model.Peering Maven / Gradle / Ivy
Show all versions of networkmanager Show documentation
/*
* 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.networkmanager.model;
import java.io.Serializable;
import java.time.Instant;
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.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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;
/**
*
* Describes a peering connection.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Peering implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField CORE_NETWORK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CoreNetworkId").getter(getter(Peering::coreNetworkId)).setter(setter(Builder::coreNetworkId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CoreNetworkId").build()).build();
private static final SdkField CORE_NETWORK_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CoreNetworkArn").getter(getter(Peering::coreNetworkArn)).setter(setter(Builder::coreNetworkArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CoreNetworkArn").build()).build();
private static final SdkField PEERING_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PeeringId").getter(getter(Peering::peeringId)).setter(setter(Builder::peeringId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PeeringId").build()).build();
private static final SdkField OWNER_ACCOUNT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OwnerAccountId").getter(getter(Peering::ownerAccountId)).setter(setter(Builder::ownerAccountId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OwnerAccountId").build()).build();
private static final SdkField PEERING_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PeeringType").getter(getter(Peering::peeringTypeAsString)).setter(setter(Builder::peeringType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PeeringType").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(Peering::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField EDGE_LOCATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EdgeLocation").getter(getter(Peering::edgeLocation)).setter(setter(Builder::edgeLocation))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EdgeLocation").build()).build();
private static final SdkField RESOURCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceArn").getter(getter(Peering::resourceArn)).setter(setter(Builder::resourceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceArn").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(Peering::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CREATED_AT_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreatedAt").getter(getter(Peering::createdAt)).setter(setter(Builder::createdAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreatedAt").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CORE_NETWORK_ID_FIELD,
CORE_NETWORK_ARN_FIELD, PEERING_ID_FIELD, OWNER_ACCOUNT_ID_FIELD, PEERING_TYPE_FIELD, STATE_FIELD,
EDGE_LOCATION_FIELD, RESOURCE_ARN_FIELD, TAGS_FIELD, CREATED_AT_FIELD));
private static final long serialVersionUID = 1L;
private final String coreNetworkId;
private final String coreNetworkArn;
private final String peeringId;
private final String ownerAccountId;
private final String peeringType;
private final String state;
private final String edgeLocation;
private final String resourceArn;
private final List tags;
private final Instant createdAt;
private Peering(BuilderImpl builder) {
this.coreNetworkId = builder.coreNetworkId;
this.coreNetworkArn = builder.coreNetworkArn;
this.peeringId = builder.peeringId;
this.ownerAccountId = builder.ownerAccountId;
this.peeringType = builder.peeringType;
this.state = builder.state;
this.edgeLocation = builder.edgeLocation;
this.resourceArn = builder.resourceArn;
this.tags = builder.tags;
this.createdAt = builder.createdAt;
}
/**
*
* The ID of the core network for the peering request.
*
*
* @return The ID of the core network for the peering request.
*/
public final String coreNetworkId() {
return coreNetworkId;
}
/**
*
* The ARN of a core network.
*
*
* @return The ARN of a core network.
*/
public final String coreNetworkArn() {
return coreNetworkArn;
}
/**
*
* The ID of the peering attachment.
*
*
* @return The ID of the peering attachment.
*/
public final String peeringId() {
return peeringId;
}
/**
*
* The ID of the account owner.
*
*
* @return The ID of the account owner.
*/
public final String ownerAccountId() {
return ownerAccountId;
}
/**
*
* The type of peering. This will be TRANSIT_GATEWAY.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #peeringType} will
* return {@link PeeringType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #peeringTypeAsString}.
*
*
* @return The type of peering. This will be TRANSIT_GATEWAY.
* @see PeeringType
*/
public final PeeringType peeringType() {
return PeeringType.fromValue(peeringType);
}
/**
*
* The type of peering. This will be TRANSIT_GATEWAY.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #peeringType} will
* return {@link PeeringType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #peeringTypeAsString}.
*
*
* @return The type of peering. This will be TRANSIT_GATEWAY.
* @see PeeringType
*/
public final String peeringTypeAsString() {
return peeringType;
}
/**
*
* The current state of the peering connection.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link PeeringState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the peering connection.
* @see PeeringState
*/
public final PeeringState state() {
return PeeringState.fromValue(state);
}
/**
*
* The current state of the peering connection.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link PeeringState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the peering connection.
* @see PeeringState
*/
public final String stateAsString() {
return state;
}
/**
*
* The edge location for the peer.
*
*
* @return The edge location for the peer.
*/
public final String edgeLocation() {
return edgeLocation;
}
/**
*
* The resource ARN of the peer.
*
*
* @return The resource ARN of the peer.
*/
public final String resourceArn() {
return resourceArn;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* The list of key-value tags associated with the peering.
*
*
* 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 {@link #hasTags} method.
*
*
* @return The list of key-value tags associated with the peering.
*/
public final List tags() {
return tags;
}
/**
*
* The timestamp when the attachment peer was created.
*
*
* @return The timestamp when the attachment peer was created.
*/
public final Instant createdAt() {
return createdAt;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(coreNetworkId());
hashCode = 31 * hashCode + Objects.hashCode(coreNetworkArn());
hashCode = 31 * hashCode + Objects.hashCode(peeringId());
hashCode = 31 * hashCode + Objects.hashCode(ownerAccountId());
hashCode = 31 * hashCode + Objects.hashCode(peeringTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(edgeLocation());
hashCode = 31 * hashCode + Objects.hashCode(resourceArn());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(createdAt());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Peering)) {
return false;
}
Peering other = (Peering) obj;
return Objects.equals(coreNetworkId(), other.coreNetworkId()) && Objects.equals(coreNetworkArn(), other.coreNetworkArn())
&& Objects.equals(peeringId(), other.peeringId()) && Objects.equals(ownerAccountId(), other.ownerAccountId())
&& Objects.equals(peeringTypeAsString(), other.peeringTypeAsString())
&& Objects.equals(stateAsString(), other.stateAsString()) && Objects.equals(edgeLocation(), other.edgeLocation())
&& Objects.equals(resourceArn(), other.resourceArn()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(createdAt(), other.createdAt());
}
/**
* 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 final String toString() {
return ToString.builder("Peering").add("CoreNetworkId", coreNetworkId()).add("CoreNetworkArn", coreNetworkArn())
.add("PeeringId", peeringId()).add("OwnerAccountId", ownerAccountId()).add("PeeringType", peeringTypeAsString())
.add("State", stateAsString()).add("EdgeLocation", edgeLocation()).add("ResourceArn", resourceArn())
.add("Tags", hasTags() ? tags() : null).add("CreatedAt", createdAt()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CoreNetworkId":
return Optional.ofNullable(clazz.cast(coreNetworkId()));
case "CoreNetworkArn":
return Optional.ofNullable(clazz.cast(coreNetworkArn()));
case "PeeringId":
return Optional.ofNullable(clazz.cast(peeringId()));
case "OwnerAccountId":
return Optional.ofNullable(clazz.cast(ownerAccountId()));
case "PeeringType":
return Optional.ofNullable(clazz.cast(peeringTypeAsString()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "EdgeLocation":
return Optional.ofNullable(clazz.cast(edgeLocation()));
case "ResourceArn":
return Optional.ofNullable(clazz.cast(resourceArn()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "CreatedAt":
return Optional.ofNullable(clazz.cast(createdAt()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Peering) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ID of the core network for the peering request.
*
*
* @param coreNetworkId
* The ID of the core network for the peering request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder coreNetworkId(String coreNetworkId);
/**
*
* The ARN of a core network.
*
*
* @param coreNetworkArn
* The ARN of a core network.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder coreNetworkArn(String coreNetworkArn);
/**
*
* The ID of the peering attachment.
*
*
* @param peeringId
* The ID of the peering attachment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder peeringId(String peeringId);
/**
*
* The ID of the account owner.
*
*
* @param ownerAccountId
* The ID of the account owner.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ownerAccountId(String ownerAccountId);
/**
*
* The type of peering. This will be TRANSIT_GATEWAY.
*
*
* @param peeringType
* The type of peering. This will be TRANSIT_GATEWAY.
* @see PeeringType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PeeringType
*/
Builder peeringType(String peeringType);
/**
*
* The type of peering. This will be TRANSIT_GATEWAY.
*
*
* @param peeringType
* The type of peering. This will be TRANSIT_GATEWAY.
* @see PeeringType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PeeringType
*/
Builder peeringType(PeeringType peeringType);
/**
*
* The current state of the peering connection.
*
*
* @param state
* The current state of the peering connection.
* @see PeeringState
* @return Returns a reference to this object so that method calls can be chained together.
* @see PeeringState
*/
Builder state(String state);
/**
*
* The current state of the peering connection.
*
*
* @param state
* The current state of the peering connection.
* @see PeeringState
* @return Returns a reference to this object so that method calls can be chained together.
* @see PeeringState
*/
Builder state(PeeringState state);
/**
*
* The edge location for the peer.
*
*
* @param edgeLocation
* The edge location for the peer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder edgeLocation(String edgeLocation);
/**
*
* The resource ARN of the peer.
*
*
* @param resourceArn
* The resource ARN of the peer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceArn(String resourceArn);
/**
*
* The list of key-value tags associated with the peering.
*
*
* @param tags
* The list of key-value tags associated with the peering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* The list of key-value tags associated with the peering.
*
*
* @param tags
* The list of key-value tags associated with the peering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* The list of key-value tags associated with the peering.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.networkmanager.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.networkmanager.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.networkmanager.model.Tag.Builder#build()} is called immediately and
* its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.networkmanager.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
/**
*
* The timestamp when the attachment peer was created.
*
*
* @param createdAt
* The timestamp when the attachment peer was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdAt(Instant createdAt);
}
static final class BuilderImpl implements Builder {
private String coreNetworkId;
private String coreNetworkArn;
private String peeringId;
private String ownerAccountId;
private String peeringType;
private String state;
private String edgeLocation;
private String resourceArn;
private List tags = DefaultSdkAutoConstructList.getInstance();
private Instant createdAt;
private BuilderImpl() {
}
private BuilderImpl(Peering model) {
coreNetworkId(model.coreNetworkId);
coreNetworkArn(model.coreNetworkArn);
peeringId(model.peeringId);
ownerAccountId(model.ownerAccountId);
peeringType(model.peeringType);
state(model.state);
edgeLocation(model.edgeLocation);
resourceArn(model.resourceArn);
tags(model.tags);
createdAt(model.createdAt);
}
public final String getCoreNetworkId() {
return coreNetworkId;
}
public final void setCoreNetworkId(String coreNetworkId) {
this.coreNetworkId = coreNetworkId;
}
@Override
public final Builder coreNetworkId(String coreNetworkId) {
this.coreNetworkId = coreNetworkId;
return this;
}
public final String getCoreNetworkArn() {
return coreNetworkArn;
}
public final void setCoreNetworkArn(String coreNetworkArn) {
this.coreNetworkArn = coreNetworkArn;
}
@Override
public final Builder coreNetworkArn(String coreNetworkArn) {
this.coreNetworkArn = coreNetworkArn;
return this;
}
public final String getPeeringId() {
return peeringId;
}
public final void setPeeringId(String peeringId) {
this.peeringId = peeringId;
}
@Override
public final Builder peeringId(String peeringId) {
this.peeringId = peeringId;
return this;
}
public final String getOwnerAccountId() {
return ownerAccountId;
}
public final void setOwnerAccountId(String ownerAccountId) {
this.ownerAccountId = ownerAccountId;
}
@Override
public final Builder ownerAccountId(String ownerAccountId) {
this.ownerAccountId = ownerAccountId;
return this;
}
public final String getPeeringType() {
return peeringType;
}
public final void setPeeringType(String peeringType) {
this.peeringType = peeringType;
}
@Override
public final Builder peeringType(String peeringType) {
this.peeringType = peeringType;
return this;
}
@Override
public final Builder peeringType(PeeringType peeringType) {
this.peeringType(peeringType == null ? null : peeringType.toString());
return this;
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(PeeringState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final String getEdgeLocation() {
return edgeLocation;
}
public final void setEdgeLocation(String edgeLocation) {
this.edgeLocation = edgeLocation;
}
@Override
public final Builder edgeLocation(String edgeLocation) {
this.edgeLocation = edgeLocation;
return this;
}
public final String getResourceArn() {
return resourceArn;
}
public final void setResourceArn(String resourceArn) {
this.resourceArn = resourceArn;
}
@Override
public final Builder resourceArn(String resourceArn) {
this.resourceArn = resourceArn;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Instant getCreatedAt() {
return createdAt;
}
public final void setCreatedAt(Instant createdAt) {
this.createdAt = createdAt;
}
@Override
public final Builder createdAt(Instant createdAt) {
this.createdAt = createdAt;
return this;
}
@Override
public Peering build() {
return new Peering(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}