Endpoint (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.eventbridge.model.Endpoint

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Endpoint
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Endpoint()

Constructors
Constructor and Description
`Endpoint()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Endpoint`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The ARN of the endpoint.
`Date`	`getCreationTime()` The time the endpoint was created.
`String`	`getDescription()` A description for the endpoint.
`String`	`getEndpointId()` The URL subdomain of the endpoint.
`String`	`getEndpointUrl()` The URL of the endpoint.
`List<EndpointEventBus>`	`getEventBuses()` The event buses being used by the endpoint.
`Date`	`getLastModifiedTime()` The last time the endpoint was modified.
`String`	`getName()` The name of the endpoint.
`ReplicationConfig`	`getReplicationConfig()` Whether event replication was enabled or disabled for this endpoint.
`String`	`getRoleArn()` The ARN of the role used by event replication for the endpoint.
`RoutingConfig`	`getRoutingConfig()` The routing configuration of the endpoint.
`String`	`getState()` The current state of the endpoint.
`String`	`getStateReason()` The reason the endpoint is in its current state.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The ARN of the endpoint.
`void`	`setCreationTime(Date creationTime)` The time the endpoint was created.
`void`	`setDescription(String description)` A description for the endpoint.
`void`	`setEndpointId(String endpointId)` The URL subdomain of the endpoint.
`void`	`setEndpointUrl(String endpointUrl)` The URL of the endpoint.
`void`	`setEventBuses(Collection<EndpointEventBus> eventBuses)` The event buses being used by the endpoint.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The last time the endpoint was modified.
`void`	`setName(String name)` The name of the endpoint.
`void`	`setReplicationConfig(ReplicationConfig replicationConfig)` Whether event replication was enabled or disabled for this endpoint.
`void`	`setRoleArn(String roleArn)` The ARN of the role used by event replication for the endpoint.
`void`	`setRoutingConfig(RoutingConfig routingConfig)` The routing configuration of the endpoint.
`void`	`setState(String state)` The current state of the endpoint.
`void`	`setStateReason(String stateReason)` The reason the endpoint is in its current state.
`String`	`toString()` Returns a string representation of this object.
`Endpoint`	`withArn(String arn)` The ARN of the endpoint.
`Endpoint`	`withCreationTime(Date creationTime)` The time the endpoint was created.
`Endpoint`	`withDescription(String description)` A description for the endpoint.
`Endpoint`	`withEndpointId(String endpointId)` The URL subdomain of the endpoint.
`Endpoint`	`withEndpointUrl(String endpointUrl)` The URL of the endpoint.
`Endpoint`	`withEventBuses(Collection<EndpointEventBus> eventBuses)` The event buses being used by the endpoint.
`Endpoint`	`withEventBuses(EndpointEventBus... eventBuses)` The event buses being used by the endpoint.
`Endpoint`	`withLastModifiedTime(Date lastModifiedTime)` The last time the endpoint was modified.
`Endpoint`	`withName(String name)` The name of the endpoint.
`Endpoint`	`withReplicationConfig(ReplicationConfig replicationConfig)` Whether event replication was enabled or disabled for this endpoint.
`Endpoint`	`withRoleArn(String roleArn)` The ARN of the role used by event replication for the endpoint.
`Endpoint`	`withRoutingConfig(RoutingConfig routingConfig)` The routing configuration of the endpoint.
`Endpoint`	`withState(EndpointState state)` The current state of the endpoint.
`Endpoint`	`withState(String state)` The current state of the endpoint.
`Endpoint`	`withStateReason(String stateReason)` The reason the endpoint is in its current state.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Endpoint
```
public Endpoint()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the endpoint.
    
    Parameters:
    
    name - The name of the endpoint.
  - getName
```
public String getName()
```
    The name of the endpoint.
    
    Returns:
    
    The name of the endpoint.
  - withName
```
public Endpoint withName(String name)
```
    The name of the endpoint.
    
    Parameters:
    
    name - The name of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description for the endpoint.
    
    Parameters:
    
    description - A description for the endpoint.
  - getDescription
```
public String getDescription()
```
    A description for the endpoint.
    
    Returns:
    
    A description for the endpoint.
  - withDescription
```
public Endpoint withDescription(String description)
```
    A description for the endpoint.
    
    Parameters:
    
    description - A description for the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The ARN of the endpoint.
    
    Parameters:
    
    arn - The ARN of the endpoint.
  - getArn
```
public String getArn()
```
    The ARN of the endpoint.
    
    Returns:
    
    The ARN of the endpoint.
  - withArn
```
public Endpoint withArn(String arn)
```
    The ARN of the endpoint.
    
    Parameters:
    
    arn - The ARN of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoutingConfig
```
public void setRoutingConfig(RoutingConfig routingConfig)
```
    The routing configuration of the endpoint.
    
    Parameters:
    
    routingConfig - The routing configuration of the endpoint.
  - getRoutingConfig
```
public RoutingConfig getRoutingConfig()
```
    The routing configuration of the endpoint.
    
    Returns:
    
    The routing configuration of the endpoint.
  - withRoutingConfig
```
public Endpoint withRoutingConfig(RoutingConfig routingConfig)
```
    The routing configuration of the endpoint.
    
    Parameters:
    
    routingConfig - The routing configuration of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReplicationConfig
```
public void setReplicationConfig(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.
    
    Parameters:
    
    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.
  - getReplicationConfig
```
public ReplicationConfig getReplicationConfig()
```
    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.
  - withReplicationConfig
```
public Endpoint withReplicationConfig(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEventBuses
```
public List<EndpointEventBus> getEventBuses()
```
    The event buses being used by the endpoint.
    
    Returns:
    
    The event buses being used by the endpoint.
  - setEventBuses
```
public void setEventBuses(Collection<EndpointEventBus> eventBuses)
```
    The event buses being used by the endpoint.
    
    Parameters:
    
    eventBuses - The event buses being used by the endpoint.
  - withEventBuses
```
public Endpoint withEventBuses(EndpointEventBus... eventBuses)
```
    The event buses being used by the endpoint.
    
    NOTE: This method appends the values to the existing list (if any). Use setEventBuses(java.util.Collection) or withEventBuses(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    eventBuses - The event buses being used by the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEventBuses
```
public Endpoint withEventBuses(Collection<EndpointEventBus> eventBuses)
```
    The event buses being used by the endpoint.
    
    Parameters:
    
    eventBuses - The event buses being used by the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN of the role used by event replication for the endpoint.
    
    Parameters:
    
    roleArn - The ARN of the role used by event replication for the endpoint.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public Endpoint withRoleArn(String roleArn)
```
    The ARN of the role used by event replication for the endpoint.
    
    Parameters:
    
    roleArn - The ARN of the role used by event replication for the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointId
```
public void setEndpointId(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.
    
    Parameters:
    
    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.
  - getEndpointId
```
public String getEndpointId()
```
    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.
  - withEndpointId
```
public Endpoint withEndpointId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointUrl
```
public void setEndpointUrl(String endpointUrl)
```
    The URL of the endpoint.
    
    Parameters:
    
    endpointUrl - The URL of the endpoint.
  - getEndpointUrl
```
public String getEndpointUrl()
```
    The URL of the endpoint.
    
    Returns:
    
    The URL of the endpoint.
  - withEndpointUrl
```
public Endpoint withEndpointUrl(String endpointUrl)
```
    The URL of the endpoint.
    
    Parameters:
    
    endpointUrl - The URL of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The current state of the endpoint.
    
    Parameters:
    
    state - The current state of the endpoint.
    
    See Also:
    
    EndpointState
  - getState
```
public String getState()
```
    The current state of the endpoint.
    
    Returns:
    
    The current state of the endpoint.
    
    See Also:
    
    EndpointState
  - withState
```
public Endpoint withState(String state)
```
    The current state of the endpoint.
    
    Parameters:
    
    state - The current state of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointState
  - withState
```
public Endpoint withState(EndpointState state)
```
    The current state of the endpoint.
    
    Parameters:
    
    state - The current state of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointState
  - setStateReason
```
public void setStateReason(String stateReason)
```
    The reason the endpoint is in its current state.
    
    Parameters:
    
    stateReason - The reason the endpoint is in its current state.
  - getStateReason
```
public String getStateReason()
```
    The reason the endpoint is in its current state.
    
    Returns:
    
    The reason the endpoint is in its current state.
  - withStateReason
```
public Endpoint withStateReason(String stateReason)
```
    The reason the endpoint is in its current state.
    
    Parameters:
    
    stateReason - The reason the endpoint is in its current state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time the endpoint was created.
    
    Parameters:
    
    creationTime - The time the endpoint was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time the endpoint was created.
    
    Returns:
    
    The time the endpoint was created.
  - withCreationTime
```
public Endpoint withCreationTime(Date creationTime)
```
    The time the endpoint was created.
    
    Parameters:
    
    creationTime - The time the endpoint was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The last time the endpoint was modified.
    
    Parameters:
    
    lastModifiedTime - The last time the endpoint was modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The last time the endpoint was modified.
    
    Returns:
    
    The last time the endpoint was modified.
  - withLastModifiedTime
```
public Endpoint withLastModifiedTime(Date lastModifiedTime)
```
    The last time the endpoint was modified.
    
    Parameters:
    
    lastModifiedTime - The last time the endpoint was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Endpoint clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class Endpoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Endpoint

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setArn

getArn

withArn

setRoutingConfig

getRoutingConfig

withRoutingConfig

setReplicationConfig

getReplicationConfig

withReplicationConfig

getEventBuses

setEventBuses

withEventBuses

withEventBuses

setRoleArn

getRoleArn

withRoleArn

setEndpointId

getEndpointId

withEndpointId

setEndpointUrl

getEndpointUrl

withEndpointUrl

setState

getState

withState

withState

setStateReason

getStateReason

withStateReason

setCreationTime

getCreationTime

withCreationTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

toString

equals

hashCode

clone

marshall