Interface DescribeApiDestinationResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeApiDestinationResponse.Builder,DescribeApiDestinationResponse>, EventBridgeResponse.Builder, SdkBuilder<DescribeApiDestinationResponse.Builder,DescribeApiDestinationResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeApiDestinationResponse

public static interface DescribeApiDestinationResponse.Builder extends EventBridgeResponse.Builder, SdkPojo, CopyableBuilder<DescribeApiDestinationResponse.Builder,DescribeApiDestinationResponse>
  • Method Details

    • apiDestinationArn

      DescribeApiDestinationResponse.Builder apiDestinationArn(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.
    • 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.
    • 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.
    • apiDestinationState

      DescribeApiDestinationResponse.Builder apiDestinationState(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

      DescribeApiDestinationResponse.Builder apiDestinationState(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:
    • connectionArn

      DescribeApiDestinationResponse.Builder connectionArn(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.
    • invocationEndpoint

      DescribeApiDestinationResponse.Builder invocationEndpoint(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.
    • 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:
    • 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:
    • invocationRateLimitPerSecond

      DescribeApiDestinationResponse.Builder invocationRateLimitPerSecond(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.
    • creationTime

      DescribeApiDestinationResponse.Builder creationTime(Instant 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.
    • lastModifiedTime

      DescribeApiDestinationResponse.Builder lastModifiedTime(Instant 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.