DescribeApiDestinationResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.eventbridge.model.DescribeApiDestinationResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeApiDestinationResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeApiDestinationResult()

Constructors
Constructor and Description
`DescribeApiDestinationResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeApiDestinationResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApiDestinationArn()` The ARN of the API destination retrieved.
`String`	`getApiDestinationState()` The state of the API destination retrieved.
`String`	`getConnectionArn()` The ARN of the connection specified for the API destination retrieved.
`Date`	`getCreationTime()` A time stamp for the time that the API destination was created.
`String`	`getDescription()` The description for the API destination retrieved.
`String`	`getHttpMethod()` The method to use to connect to the HTTP endpoint.
`String`	`getInvocationEndpoint()` The URL to use to connect to the HTTP endpoint.
`Integer`	`getInvocationRateLimitPerSecond()` The maximum number of invocations per second to specified for the API destination.
`Date`	`getLastModifiedTime()` A time stamp for the time that the API destination was last modified.
`String`	`getName()` The name of the API destination retrieved.
`int`	`hashCode()`
`void`	`setApiDestinationArn(String apiDestinationArn)` The ARN of the API destination retrieved.
`void`	`setApiDestinationState(String apiDestinationState)` The state of the API destination retrieved.
`void`	`setConnectionArn(String connectionArn)` The ARN of the connection specified for the API destination retrieved.
`void`	`setCreationTime(Date creationTime)` A time stamp for the time that the API destination was created.
`void`	`setDescription(String description)` The description for the API destination retrieved.
`void`	`setHttpMethod(String httpMethod)` The method to use to connect to the HTTP endpoint.
`void`	`setInvocationEndpoint(String invocationEndpoint)` The URL to use to connect to the HTTP endpoint.
`void`	`setInvocationRateLimitPerSecond(Integer invocationRateLimitPerSecond)` The maximum number of invocations per second to specified for the API destination.
`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 retrieved.
`String`	`toString()` Returns a string representation of this object.
`DescribeApiDestinationResult`	`withApiDestinationArn(String apiDestinationArn)` The ARN of the API destination retrieved.
`DescribeApiDestinationResult`	`withApiDestinationState(ApiDestinationState apiDestinationState)` The state of the API destination retrieved.
`DescribeApiDestinationResult`	`withApiDestinationState(String apiDestinationState)` The state of the API destination retrieved.
`DescribeApiDestinationResult`	`withConnectionArn(String connectionArn)` The ARN of the connection specified for the API destination retrieved.
`DescribeApiDestinationResult`	`withCreationTime(Date creationTime)` A time stamp for the time that the API destination was created.
`DescribeApiDestinationResult`	`withDescription(String description)` The description for the API destination retrieved.
`DescribeApiDestinationResult`	`withHttpMethod(ApiDestinationHttpMethod httpMethod)` The method to use to connect to the HTTP endpoint.
`DescribeApiDestinationResult`	`withHttpMethod(String httpMethod)` The method to use to connect to the HTTP endpoint.
`DescribeApiDestinationResult`	`withInvocationEndpoint(String invocationEndpoint)` The URL to use to connect to the HTTP endpoint.
`DescribeApiDestinationResult`	`withInvocationRateLimitPerSecond(Integer invocationRateLimitPerSecond)` The maximum number of invocations per second to specified for the API destination.
`DescribeApiDestinationResult`	`withLastModifiedTime(Date lastModifiedTime)` A time stamp for the time that the API destination was last modified.
`DescribeApiDestinationResult`	`withName(String name)` The name of the API destination retrieved.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeApiDestinationResult
```
public DescribeApiDestinationResult()
```
- Method Detail
  - setApiDestinationArn
```
public void setApiDestinationArn(String apiDestinationArn)
```
    The ARN of the API destination retrieved.
    
    Parameters:
    
    apiDestinationArn - The ARN of the API destination retrieved.
  - getApiDestinationArn
```
public String getApiDestinationArn()
```
    The ARN of the API destination retrieved.
    
    Returns:
    
    The ARN of the API destination retrieved.
  - withApiDestinationArn
```
public DescribeApiDestinationResult withApiDestinationArn(String apiDestinationArn)
```
    The ARN of the API destination retrieved.
    
    Parameters:
    
    apiDestinationArn - The ARN of the API destination retrieved.
    
    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 retrieved.
    
    Parameters:
    
    name - The name of the API destination retrieved.
  - getName
```
public String getName()
```
    The name of the API destination retrieved.
    
    Returns:
    
    The name of the API destination retrieved.
  - withName
```
public DescribeApiDestinationResult withName(String name)
```
    The name of the API destination retrieved.
    
    Parameters:
    
    name - The name of the API destination retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for the API destination retrieved.
    
    Parameters:
    
    description - The description for the API destination retrieved.
  - getDescription
```
public String getDescription()
```
    The description for the API destination retrieved.
    
    Returns:
    
    The description for the API destination retrieved.
  - withDescription
```
public DescribeApiDestinationResult withDescription(String description)
```
    The description for the API destination retrieved.
    
    Parameters:
    
    description - The description for the API destination retrieved.
    
    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 retrieved.
    
    Parameters:
    
    apiDestinationState - The state of the API destination retrieved.
    
    See Also:
    
    ApiDestinationState
  - getApiDestinationState
```
public String getApiDestinationState()
```
    The state of the API destination retrieved.
    
    Returns:
    
    The state of the API destination retrieved.
    
    See Also:
    
    ApiDestinationState
  - withApiDestinationState
```
public DescribeApiDestinationResult withApiDestinationState(String apiDestinationState)
```
    The state of the API destination retrieved.
    
    Parameters:
    
    apiDestinationState - The state of the API destination retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ApiDestinationState
  - withApiDestinationState
```
public DescribeApiDestinationResult withApiDestinationState(ApiDestinationState apiDestinationState)
```
    The state of the API destination retrieved.
    
    Parameters:
    
    apiDestinationState - The state of the API destination retrieved.
    
    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 retrieved.
    
    Parameters:
    
    connectionArn - The ARN of the connection specified for the API destination retrieved.
  - getConnectionArn
```
public String getConnectionArn()
```
    The ARN of the connection specified for the API destination retrieved.
    
    Returns:
    
    The ARN of the connection specified for the API destination retrieved.
  - withConnectionArn
```
public DescribeApiDestinationResult withConnectionArn(String connectionArn)
```
    The ARN of the connection specified for the API destination retrieved.
    
    Parameters:
    
    connectionArn - The ARN of the connection specified for the API destination retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInvocationEndpoint
```
public void setInvocationEndpoint(String invocationEndpoint)
```
    The URL to use to connect to the HTTP endpoint.
    
    Parameters:
    
    invocationEndpoint - The URL to use to connect to the HTTP endpoint.
  - getInvocationEndpoint
```
public String getInvocationEndpoint()
```
    The URL to use to connect to the HTTP endpoint.
    
    Returns:
    
    The URL to use to connect to the HTTP endpoint.
  - withInvocationEndpoint
```
public DescribeApiDestinationResult withInvocationEndpoint(String invocationEndpoint)
```
    The URL to use to connect to the HTTP endpoint.
    
    Parameters:
    
    invocationEndpoint - The URL to use to connect to the HTTP endpoint.
    
    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 DescribeApiDestinationResult 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 DescribeApiDestinationResult 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 specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
    
    Parameters:
    
    invocationRateLimitPerSecond - The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
  - getInvocationRateLimitPerSecond
```
public Integer getInvocationRateLimitPerSecond()
```
    The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
    
    Returns:
    
    The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
  - withInvocationRateLimitPerSecond
```
public DescribeApiDestinationResult withInvocationRateLimitPerSecond(Integer invocationRateLimitPerSecond)
```
    The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
    
    Parameters:
    
    invocationRateLimitPerSecond - The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
    
    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 DescribeApiDestinationResult 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 DescribeApiDestinationResult 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 DescribeApiDestinationResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class DescribeApiDestinationResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeApiDestinationResult

Method Detail

setApiDestinationArn

getApiDestinationArn

withApiDestinationArn

setName

getName

withName

setDescription

getDescription

withDescription

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