Interface CreateBillEstimateResponse.Builder

    • Method Detail

      • id

        CreateBillEstimateResponse.Builder id​(String id)

        The unique identifier of your newly created Bill estimate.

        Parameters:
        id - The unique identifier of your newly created Bill estimate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • name

        CreateBillEstimateResponse.Builder name​(String name)

        The name of your newly created Bill estimate.

        Parameters:
        name - The name of your newly created Bill estimate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • status

        CreateBillEstimateResponse.Builder status​(String status)

        The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

        Parameters:
        status - The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BillEstimateStatus, BillEstimateStatus
      • status

        CreateBillEstimateResponse.Builder status​(BillEstimateStatus status)

        The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

        Parameters:
        status - The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BillEstimateStatus, BillEstimateStatus
      • failureMessage

        CreateBillEstimateResponse.Builder failureMessage​(String failureMessage)

        This attribute provides the reason if a Bill estimate result generation fails.

        Parameters:
        failureMessage - This attribute provides the reason if a Bill estimate result generation fails.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • billInterval

        CreateBillEstimateResponse.Builder billInterval​(BillInterval billInterval)

        The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

        Parameters:
        billInterval - The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • costSummary

        CreateBillEstimateResponse.Builder costSummary​(BillEstimateCostSummary costSummary)

        Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

        Parameters:
        costSummary - Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • createdAt

        CreateBillEstimateResponse.Builder createdAt​(Instant createdAt)

        The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).

        Parameters:
        createdAt - The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • expiresAt

        CreateBillEstimateResponse.Builder expiresAt​(Instant expiresAt)

        The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.

        Parameters:
        expiresAt - The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.