ApiDestination (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ApiDestination
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains details about an API destination.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ApiDestination()

Constructors
Constructor and Description
`ApiDestination()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiDestination`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApiDestinationArn()` The ARN of the API destination.
`String`	`getApiDestinationState()` The state of the API destination.
`String`	`getConnectionArn()` The ARN of the connection specified for the API destination.
`Date`	`getCreationTime()` A time stamp for the time that the API destination was created.
`String`	`getHttpMethod()` The method to use to connect to the HTTP endpoint.
`String`	`getInvocationEndpoint()` The URL to the endpoint for the API destination.
`Integer`	`getInvocationRateLimitPerSecond()` The maximum number of invocations per second to send to the HTTP endpoint.
`Date`	`getLastModifiedTime()` A time stamp for the time that the API destination was last modified.
`String`	`getName()` The name of the API destination.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApiDestinationArn(String apiDestinationArn)` The ARN of the API destination.
`void`	`setApiDestinationState(String apiDestinationState)` The state of the API destination.
`void`	`setConnectionArn(String connectionArn)` The ARN of the connection specified for the API destination.
`void`	`setCreationTime(Date creationTime)` A time stamp for the time that the API destination was created.
`void`	`setHttpMethod(String httpMethod)` The method to use to connect to the HTTP endpoint.
`void`	`setInvocationEndpoint(String invocationEndpoint)` The URL to the endpoint for the API destination.
`void`	`setInvocationRateLimitPerSecond(Integer invocationRateLimitPerSecond)` The maximum number of invocations per second to send to the HTTP endpoint.
`void`	`setLastModifiedTime(Date lastModifiedTime)` A time stamp for the time that the API destination was last modified.
`void`	`setName(String name)` The name of the API destination.
`String`	`toString()` Returns a string representation of this object.
`ApiDestination`	`withApiDestinationArn(String apiDestinationArn)` The ARN of the API destination.
`ApiDestination`	`withApiDestinationState(ApiDestinationState apiDestinationState)` The state of the API destination.
`ApiDestination`	`withApiDestinationState(String apiDestinationState)` The state of the API destination.
`ApiDestination`	`withConnectionArn(String connectionArn)` The ARN of the connection specified for the API destination.
`ApiDestination`	`withCreationTime(Date creationTime)` A time stamp for the time that the API destination was created.
`ApiDestination`	`withHttpMethod(ApiDestinationHttpMethod httpMethod)` The method to use to connect to the HTTP endpoint.
`ApiDestination`	`withHttpMethod(String httpMethod)` The method to use to connect to the HTTP endpoint.
`ApiDestination`	`withInvocationEndpoint(String invocationEndpoint)` The URL to the endpoint for the API destination.
`ApiDestination`	`withInvocationRateLimitPerSecond(Integer invocationRateLimitPerSecond)` The maximum number of invocations per second to send to the HTTP endpoint.
`ApiDestination`	`withLastModifiedTime(Date lastModifiedTime)` A time stamp for the time that the API destination was last modified.
`ApiDestination`	`withName(String name)` The name of the API destination.

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

- Constructor Detail
  - ApiDestination
```
public ApiDestination()
```
- Method Detail
  - setApiDestinationArn
```
public void setApiDestinationArn(String apiDestinationArn)
```
    The ARN of the API destination.
    
    Parameters:
    
    apiDestinationArn - The ARN of the API destination.
  - getApiDestinationArn
```
public String getApiDestinationArn()
```
    The ARN of the API destination.
    
    Returns:
    
    The ARN of the API destination.
  - withApiDestinationArn
```
public ApiDestination withApiDestinationArn(String apiDestinationArn)
```
    The ARN of the API destination.
    
    Parameters:
    
    apiDestinationArn - The ARN of the API destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the API destination.
    
    Parameters:
    
    name - The name of the API destination.
  - getName
```
public String getName()
```
    The name of the API destination.
    
    Returns:
    
    The name of the API destination.
  - withName
```
public ApiDestination withName(String name)
```
    The name of the API destination.
    
    Parameters:
    
    name - The name of the API destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiDestinationState
```
public void setApiDestinationState(String apiDestinationState)
```
    The state of the API destination.
    
    Parameters:
    
    apiDestinationState - The state of the API destination.
    
    See Also:
    
    ApiDestinationState
  - getApiDestinationState
```
public String getApiDestinationState()
```
    The state of the API destination.
    
    Returns:
    
    The state of the API destination.
    
    See Also:
    
    ApiDestinationState
  - withApiDestinationState
```
public ApiDestination withApiDestinationState(String apiDestinationState)
```
    The state of the API destination.
    
    Parameters:
    
    apiDestinationState - The state of the API destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ApiDestinationState
  - withApiDestinationState
```
public ApiDestination withApiDestinationState(ApiDestinationState apiDestinationState)
```
    The state of the API destination.
    
    Parameters:
    
    apiDestinationState - The state of the API destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ApiDestinationState
  - setConnectionArn
```
public void setConnectionArn(String connectionArn)
```
    The ARN of the connection specified for the API destination.
    
    Parameters:
    
    connectionArn - The ARN of the connection specified for the API destination.
  - getConnectionArn
```
public String getConnectionArn()
```
    The ARN of the connection specified for the API destination.
    
    Returns:
    
    The ARN of the connection specified for the API destination.
  - withConnectionArn
```
public ApiDestination withConnectionArn(String connectionArn)
```
    The ARN of the connection specified for the API destination.
    
    Parameters:
    
    connectionArn - The ARN of the connection specified for the API destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInvocationEndpoint
```
public void setInvocationEndpoint(String invocationEndpoint)
```
    The URL to the endpoint for the API destination.
    
    Parameters:
    
    invocationEndpoint - The URL to the endpoint for the API destination.
  - getInvocationEndpoint
```
public String getInvocationEndpoint()
```
    The URL to the endpoint for the API destination.
    
    Returns:
    
    The URL to the endpoint for the API destination.
  - withInvocationEndpoint
```
public ApiDestination withInvocationEndpoint(String invocationEndpoint)
```
    The URL to the endpoint for the API destination.
    
    Parameters:
    
    invocationEndpoint - The URL to the endpoint for the API destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHttpMethod
```
public void setHttpMethod(String httpMethod)
```
    The method to use to connect to the HTTP endpoint.
    
    Parameters:
    
    httpMethod - The method to use to connect to the HTTP endpoint.
    
    See Also:
    
    ApiDestinationHttpMethod
  - getHttpMethod
```
public String getHttpMethod()
```
    The method to use to connect to the HTTP endpoint.
    
    Returns:
    
    The method to use to connect to the HTTP endpoint.
    
    See Also:
    
    ApiDestinationHttpMethod
  - withHttpMethod
```
public ApiDestination withHttpMethod(String httpMethod)
```
    The method to use to connect to the HTTP endpoint.
    
    Parameters:
    
    httpMethod - The method to use to connect to the HTTP endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ApiDestinationHttpMethod
  - withHttpMethod
```
public ApiDestination withHttpMethod(ApiDestinationHttpMethod httpMethod)
```
    The method to use to connect to the HTTP endpoint.
    
    Parameters:
    
    httpMethod - The method to use to connect to the HTTP endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ApiDestinationHttpMethod
  - setInvocationRateLimitPerSecond
```
public void setInvocationRateLimitPerSecond(Integer invocationRateLimitPerSecond)
```
    The maximum number of invocations per second to send to the HTTP endpoint.
    
    Parameters:
    
    invocationRateLimitPerSecond - The maximum number of invocations per second to send to the HTTP endpoint.
  - getInvocationRateLimitPerSecond
```
public Integer getInvocationRateLimitPerSecond()
```
    The maximum number of invocations per second to send to the HTTP endpoint.
    
    Returns:
    
    The maximum number of invocations per second to send to the HTTP endpoint.
  - withInvocationRateLimitPerSecond
```
public ApiDestination withInvocationRateLimitPerSecond(Integer invocationRateLimitPerSecond)
```
    The maximum number of invocations per second to send to the HTTP endpoint.
    
    Parameters:
    
    invocationRateLimitPerSecond - The maximum number of invocations per second to send to the HTTP endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A time stamp for the time that the API destination was created.
    
    Parameters:
    
    creationTime - A time stamp for the time that the API destination was created.
  - getCreationTime
```
public Date getCreationTime()
```
    A time stamp for the time that the API destination was created.
    
    Returns:
    
    A time stamp for the time that the API destination was created.
  - withCreationTime
```
public ApiDestination withCreationTime(Date creationTime)
```
    A time stamp for the time that the API destination was created.
    
    Parameters:
    
    creationTime - A time stamp for the time that the API destination was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    A time stamp for the time that the API destination was last modified.
    
    Parameters:
    
    lastModifiedTime - A time stamp for the time that the API destination was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    A time stamp for the time that the API destination was last modified.
    
    Returns:
    
    A time stamp for the time that the API destination was last modified.
  - withLastModifiedTime
```
public ApiDestination withLastModifiedTime(Date lastModifiedTime)
```
    A time stamp for the time that the API destination was last modified.
    
    Parameters:
    
    lastModifiedTime - A time stamp for the time that the API destination was last 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 ApiDestination 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.

Did this page help you?

Class ApiDestination

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiDestination

Method Detail

setApiDestinationArn

getApiDestinationArn

withApiDestinationArn

setName

getName

withName

setApiDestinationState

getApiDestinationState

withApiDestinationState

withApiDestinationState

setConnectionArn

getConnectionArn

withConnectionArn

setInvocationEndpoint

getInvocationEndpoint

withInvocationEndpoint

setHttpMethod

getHttpMethod

withHttpMethod

withHttpMethod

setInvocationRateLimitPerSecond

getInvocationRateLimitPerSecond

withInvocationRateLimitPerSecond

setCreationTime

getCreationTime

withCreationTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

toString

equals

hashCode

clone

marshall