Package software.amazon.awssdk.services.eventbridge.model

Interface ListArchivesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListArchivesRequest.Builder,ListArchivesRequest>, EventBridgeRequest.Builder, SdkBuilder<ListArchivesRequest.Builder,ListArchivesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListArchivesRequest
@Mutable @NotThreadSafe public static interface ListArchivesRequest.Builder extends EventBridgeRequest.Builder, SdkPojo, CopyableBuilder<ListArchivesRequest.Builder,ListArchivesRequest>

  • Method Details

    • namePrefix

      ListArchivesRequest.Builder namePrefix(String namePrefix)

      A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

      Parameters:
      namePrefix - A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventSourceArn

      ListArchivesRequest.Builder eventSourceArn(String eventSourceArn)

      The ARN of the event source associated with the archive.

      Parameters:
      eventSourceArn - The ARN of the event source associated with the archive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      ListArchivesRequest.Builder state(String state)

      The state of the archive.

      Parameters:
      state - The state of the archive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      ListArchivesRequest.Builder state(ArchiveState state)

      The state of the archive.

      Parameters:
      state - The state of the archive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      ListArchivesRequest.Builder nextToken(String nextToken)

      The token returned by a previous call, which you can use to retrieve the next set of results.

      The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

      Using an expired pagination token results in an HTTP 400 InvalidToken error.

      Parameters:
      nextToken - The token returned by a previous call, which you can use to retrieve the next set of results.

      The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

      Using an expired pagination token results in an HTTP 400 InvalidToken error.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limit

      ListArchivesRequest.Builder limit(Integer limit)

      The maximum number of results to return.

      Parameters:
      limit - The maximum number of results to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListArchivesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      ListArchivesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder