software.amazon.awssdk.services.eventbridge.model.Endpoint Maven / Gradle / Ivy
Show all versions of eventbridge 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.eventbridge.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;
/**
*
* An global endpoint used to improve your application's availability by making it regional-fault tolerant. For more
* information about global endpoints, see Making applications
* Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Endpoint implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Endpoint::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(Endpoint::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(Endpoint::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField ROUTING_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("RoutingConfig")
.getter(getter(Endpoint::routingConfig)).setter(setter(Builder::routingConfig)).constructor(RoutingConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoutingConfig").build()).build();
private static final SdkField REPLICATION_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ReplicationConfig")
.getter(getter(Endpoint::replicationConfig)).setter(setter(Builder::replicationConfig))
.constructor(ReplicationConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicationConfig").build()).build();
private static final SdkField> EVENT_BUSES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EventBuses")
.getter(getter(Endpoint::eventBuses))
.setter(setter(Builder::eventBuses))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventBuses").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EndpointEventBus::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RoleArn").getter(getter(Endpoint::roleArn)).setter(setter(Builder::roleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoleArn").build()).build();
private static final SdkField ENDPOINT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointId").getter(getter(Endpoint::endpointId)).setter(setter(Builder::endpointId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointId").build()).build();
private static final SdkField ENDPOINT_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointUrl").getter(getter(Endpoint::endpointUrl)).setter(setter(Builder::endpointUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointUrl").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(Endpoint::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField STATE_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StateReason").getter(getter(Endpoint::stateReason)).setter(setter(Builder::stateReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StateReason").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(Endpoint::creationTime)).setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final SdkField LAST_MODIFIED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModifiedTime").getter(getter(Endpoint::lastModifiedTime)).setter(setter(Builder::lastModifiedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTime").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, DESCRIPTION_FIELD,
ARN_FIELD, ROUTING_CONFIG_FIELD, REPLICATION_CONFIG_FIELD, EVENT_BUSES_FIELD, ROLE_ARN_FIELD, ENDPOINT_ID_FIELD,
ENDPOINT_URL_FIELD, STATE_FIELD, STATE_REASON_FIELD, CREATION_TIME_FIELD, LAST_MODIFIED_TIME_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String description;
private final String arn;
private final RoutingConfig routingConfig;
private final ReplicationConfig replicationConfig;
private final List eventBuses;
private final String roleArn;
private final String endpointId;
private final String endpointUrl;
private final String state;
private final String stateReason;
private final Instant creationTime;
private final Instant lastModifiedTime;
private Endpoint(BuilderImpl builder) {
this.name = builder.name;
this.description = builder.description;
this.arn = builder.arn;
this.routingConfig = builder.routingConfig;
this.replicationConfig = builder.replicationConfig;
this.eventBuses = builder.eventBuses;
this.roleArn = builder.roleArn;
this.endpointId = builder.endpointId;
this.endpointUrl = builder.endpointUrl;
this.state = builder.state;
this.stateReason = builder.stateReason;
this.creationTime = builder.creationTime;
this.lastModifiedTime = builder.lastModifiedTime;
}
/**
*
* The name of the endpoint.
*
*
* @return The name of the endpoint.
*/
public final String name() {
return name;
}
/**
*
* A description for the endpoint.
*
*
* @return A description for the endpoint.
*/
public final String description() {
return description;
}
/**
*
* The ARN of the endpoint.
*
*
* @return The ARN of the endpoint.
*/
public final String arn() {
return arn;
}
/**
*
* The routing configuration of the endpoint.
*
*
* @return The routing configuration of the endpoint.
*/
public final RoutingConfig routingConfig() {
return routingConfig;
}
/**
*
* Whether event replication was enabled or disabled for this endpoint.
*
*
* @return Whether event replication was enabled or disabled for this endpoint.
*/
public final ReplicationConfig replicationConfig() {
return replicationConfig;
}
/**
* For responses, this returns true if the service returned a value for the EventBuses 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 hasEventBuses() {
return eventBuses != null && !(eventBuses instanceof SdkAutoConstructList);
}
/**
*
* The event buses being used by the endpoint.
*
*
* 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 #hasEventBuses} method.
*
*
* @return The event buses being used by the endpoint.
*/
public final List eventBuses() {
return eventBuses;
}
/**
*
* The ARN of the role used by event replication for the endpoint.
*
*
* @return The ARN of the role used by event replication for the endpoint.
*/
public final String roleArn() {
return roleArn;
}
/**
*
* The URL subdomain of the endpoint. For example, if the URL for Endpoint is
* abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo
.
*
*
* @return The URL subdomain of the endpoint. For example, if the URL for Endpoint is
* abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo
.
*/
public final String endpointId() {
return endpointId;
}
/**
*
* The URL of the endpoint.
*
*
* @return The URL of the endpoint.
*/
public final String endpointUrl() {
return endpointUrl;
}
/**
*
* The current state of the endpoint.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link EndpointState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the endpoint.
* @see EndpointState
*/
public final EndpointState state() {
return EndpointState.fromValue(state);
}
/**
*
* The current state of the endpoint.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link EndpointState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the endpoint.
* @see EndpointState
*/
public final String stateAsString() {
return state;
}
/**
*
* The reason the endpoint is in its current state.
*
*
* @return The reason the endpoint is in its current state.
*/
public final String stateReason() {
return stateReason;
}
/**
*
* The time the endpoint was created.
*
*
* @return The time the endpoint was created.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* The last time the endpoint was modified.
*
*
* @return The last time the endpoint was modified.
*/
public final Instant lastModifiedTime() {
return lastModifiedTime;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(routingConfig());
hashCode = 31 * hashCode + Objects.hashCode(replicationConfig());
hashCode = 31 * hashCode + Objects.hashCode(hasEventBuses() ? eventBuses() : null);
hashCode = 31 * hashCode + Objects.hashCode(roleArn());
hashCode = 31 * hashCode + Objects.hashCode(endpointId());
hashCode = 31 * hashCode + Objects.hashCode(endpointUrl());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(stateReason());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTime());
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 Endpoint)) {
return false;
}
Endpoint other = (Endpoint) obj;
return Objects.equals(name(), other.name()) && Objects.equals(description(), other.description())
&& Objects.equals(arn(), other.arn()) && Objects.equals(routingConfig(), other.routingConfig())
&& Objects.equals(replicationConfig(), other.replicationConfig()) && hasEventBuses() == other.hasEventBuses()
&& Objects.equals(eventBuses(), other.eventBuses()) && Objects.equals(roleArn(), other.roleArn())
&& Objects.equals(endpointId(), other.endpointId()) && Objects.equals(endpointUrl(), other.endpointUrl())
&& Objects.equals(stateAsString(), other.stateAsString()) && Objects.equals(stateReason(), other.stateReason())
&& Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(lastModifiedTime(), other.lastModifiedTime());
}
/**
* 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("Endpoint").add("Name", name()).add("Description", description()).add("Arn", arn())
.add("RoutingConfig", routingConfig()).add("ReplicationConfig", replicationConfig())
.add("EventBuses", hasEventBuses() ? eventBuses() : null).add("RoleArn", roleArn())
.add("EndpointId", endpointId()).add("EndpointUrl", endpointUrl()).add("State", stateAsString())
.add("StateReason", stateReason()).add("CreationTime", creationTime())
.add("LastModifiedTime", lastModifiedTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "RoutingConfig":
return Optional.ofNullable(clazz.cast(routingConfig()));
case "ReplicationConfig":
return Optional.ofNullable(clazz.cast(replicationConfig()));
case "EventBuses":
return Optional.ofNullable(clazz.cast(eventBuses()));
case "RoleArn":
return Optional.ofNullable(clazz.cast(roleArn()));
case "EndpointId":
return Optional.ofNullable(clazz.cast(endpointId()));
case "EndpointUrl":
return Optional.ofNullable(clazz.cast(endpointUrl()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "StateReason":
return Optional.ofNullable(clazz.cast(stateReason()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "LastModifiedTime":
return Optional.ofNullable(clazz.cast(lastModifiedTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function