Endpoint (AWS Java SDK :: Services :: EventBridge 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.eventbridge.model.Endpoint

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Endpoint.Builder,Endpoint>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Endpoint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Endpoint.Builder,Endpoint>
```
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..

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Endpoint.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Endpoint.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The ARN of the endpoint.
`static Endpoint.Builder`	`builder()`
`Instant`	`creationTime()` The time the endpoint was created.
`String`	`description()` A description for the endpoint.
`String`	`endpointId()` The URL subdomain of the endpoint.
`String`	`endpointUrl()` The URL of the endpoint.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<EndpointEventBus>`	`eventBuses()` The event buses being used by the endpoint.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEventBuses()` For responses, this returns true if the service returned a value for the EventBuses property.
`int`	`hashCode()`
`Instant`	`lastModifiedTime()` The last time the endpoint was modified.
`String`	`name()` The name of the endpoint.
`ReplicationConfig`	`replicationConfig()` Whether event replication was enabled or disabled for this endpoint.
`String`	`roleArn()` The ARN of the role used by event replication for the endpoint.
`RoutingConfig`	`routingConfig()` The routing configuration of the endpoint.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Endpoint.Builder>`	`serializableBuilderClass()`
`EndpointState`	`state()` The current state of the endpoint.
`String`	`stateAsString()` The current state of the endpoint.
`String`	`stateReason()` The reason the endpoint is in its current state.
`Endpoint.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
  - 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.
    
    Returns:
    
    Whether event replication was enabled or disabled for this endpoint.
  - 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 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 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:
    
    EndpointState
  - 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:
    
    EndpointState
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Endpoint.Builder,Endpoint>
  - 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)
```
    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

Class Endpoint

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

description

arn

routingConfig

replicationConfig

hasEventBuses

eventBuses

roleArn

endpointId

endpointUrl

state

stateAsString

stateReason

creationTime

lastModifiedTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields