Class Endpoint

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

A 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 .

See Also:

  • Method Details

    • name

      public final String name()

      The name of the endpoint.

      Returns:
      The name of the endpoint.

    • description

      public final String description()

      A description for the endpoint.

      Returns:
      A description for the endpoint.

    • arn

      public final String arn()

      The ARN of the endpoint.

      Returns:
      The ARN of the endpoint.

    • routingConfig

      public final RoutingConfig routingConfig()

      The routing configuration of the endpoint.

      Returns:
      The routing configuration of the endpoint.

    • replicationConfig

      public final ReplicationConfig replicationConfig()

      Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

      Returns:
      Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

    • hasEventBuses

      public final boolean hasEventBuses()
      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 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.

    • eventBuses

      public final List<EndpointEventBus> eventBuses()

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

      Returns:
      The event buses being used by the endpoint.

    • roleArn

      public final String roleArn()

      The ARN of the role used by event replication for the endpoint.

      Returns:
      The ARN of the role used by event replication for the endpoint.

    • endpointId

      public final String endpointId()

      The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

      Returns:
      The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

    • endpointUrl

      public final String endpointUrl()

      The URL of the endpoint.

      Returns:
      The URL of the endpoint.

    • state

      public final EndpointState state()

      The current state of the endpoint.

      If the service returns an enum value that is not available in the current SDK version, state will return EndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the endpoint.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the endpoint.

      If the service returns an enum value that is not available in the current SDK version, state will return EndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the endpoint.
      See Also:

    • stateReason

      public final String stateReason()

      The reason the endpoint is in its current state.

      Returns:
      The reason the endpoint is in its current state.

    • creationTime

      public final Instant creationTime()

      The time the endpoint was created.

      Returns:
      The time the endpoint was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The last time the endpoint was modified.

      Returns:
      The last time the endpoint was modified.

    • toBuilder

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

    • builder

      public static Endpoint.Builder builder()

    • serializableBuilderClass

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