Interface DescribeCommunicationsRequest.Builder

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

  • Method Details

    • caseId

      DescribeCommunicationsRequest.Builder caseId(String caseId)

      The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-exen-2025-c4c1d2bf33c5cf47

      Parameters:
      caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-exen-2025-c4c1d2bf33c5cf47
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • beforeTime

      DescribeCommunicationsRequest.Builder beforeTime(String beforeTime)

      The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation.

      Parameters:
      beforeTime - The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • afterTime

      DescribeCommunicationsRequest.Builder afterTime(String afterTime)

      The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation.

      Parameters:
      afterTime - The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeCommunicationsRequest.Builder nextToken(String nextToken)

      A resumption point for pagination.

      Parameters:
      nextToken - A resumption point for pagination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeCommunicationsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return before paginating.

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

    • dryRun

      DescribeCommunicationsRequest.Builder dryRun(Boolean dryRun)

      Specifies whether to validate the request without actually returning communications. When set to true, the request is validated but no communications are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

      Parameters:
      dryRun - Specifies whether to validate the request without actually returning communications. When set to true, the request is validated but no communications are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeCommunicationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeCommunicationsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.