Interface GetQuotaUtilizationReportResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetQuotaUtilizationReportResponse.Builder,GetQuotaUtilizationReportResponse>, SdkBuilder<GetQuotaUtilizationReportResponse.Builder,GetQuotaUtilizationReportResponse>, SdkPojo, SdkResponse.Builder, ServiceQuotasResponse.Builder
Enclosing class:
GetQuotaUtilizationReportResponse
@Mutable @NotThreadSafe public static interface GetQuotaUtilizationReportResponse.Builder extends ServiceQuotasResponse.Builder, SdkPojo, CopyableBuilder<GetQuotaUtilizationReportResponse.Builder,GetQuotaUtilizationReportResponse>

  • Method Details

    • reportId

      GetQuotaUtilizationReportResponse.Builder reportId(String reportId)

      The unique identifier for the quota utilization report.

      Parameters:
      reportId - The unique identifier for the quota utilization report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetQuotaUtilizationReportResponse.Builder status(String status)

      The current status of the report generation. Possible values are:

      • PENDING - The report generation is in progress. Retry this operation after a few seconds.

      • IN_PROGRESS - The report is being processed. Continue polling until the status changes to COMPLETED.

      • COMPLETED - The report is ready and quota utilization data is available in the response.

      • FAILED - The report generation failed. Check the ErrorCode and ErrorMessage fields for details.

      Parameters:
      status - The current status of the report generation. Possible values are:

      • PENDING - The report generation is in progress. Retry this operation after a few seconds.

      • IN_PROGRESS - The report is being processed. Continue polling until the status changes to COMPLETED.

      • COMPLETED - The report is ready and quota utilization data is available in the response.

      • FAILED - The report generation failed. Check the ErrorCode and ErrorMessage fields for details.

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

    • status

      GetQuotaUtilizationReportResponse.Builder status(ReportStatus status)

      The current status of the report generation. Possible values are:

      • PENDING - The report generation is in progress. Retry this operation after a few seconds.

      • IN_PROGRESS - The report is being processed. Continue polling until the status changes to COMPLETED.

      • COMPLETED - The report is ready and quota utilization data is available in the response.

      • FAILED - The report generation failed. Check the ErrorCode and ErrorMessage fields for details.

      Parameters:
      status - The current status of the report generation. Possible values are:

      • PENDING - The report generation is in progress. Retry this operation after a few seconds.

      • IN_PROGRESS - The report is being processed. Continue polling until the status changes to COMPLETED.

      • COMPLETED - The report is ready and quota utilization data is available in the response.

      • FAILED - The report generation failed. Check the ErrorCode and ErrorMessage fields for details.

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

    • generatedAt

      GetQuotaUtilizationReportResponse.Builder generatedAt(Instant generatedAt)

      The timestamp when the report was generated, in ISO 8601 format.

      Parameters:
      generatedAt - The timestamp when the report was generated, in ISO 8601 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalCount

      GetQuotaUtilizationReportResponse.Builder totalCount(Integer totalCount)

      The total number of quotas included in the report across all pages.

      Parameters:
      totalCount - The total number of quotas included in the report across all pages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • quotas

      GetQuotaUtilizationReportResponse.Builder quotas(Collection<QuotaUtilizationInfo> quotas)

      A list of quota utilization records, sorted by utilization percentage in descending order. Each record includes the quota code, service code, service name, quota name, namespace, utilization percentage, default value, applied value, and whether the quota is adjustable. Up to 1,000 records are returned per page.

      Parameters:
      quotas - A list of quota utilization records, sorted by utilization percentage in descending order. Each record includes the quota code, service code, service name, quota name, namespace, utilization percentage, default value, applied value, and whether the quota is adjustable. Up to 1,000 records are returned per page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • quotas

      GetQuotaUtilizationReportResponse.Builder quotas(QuotaUtilizationInfo... quotas)

      A list of quota utilization records, sorted by utilization percentage in descending order. Each record includes the quota code, service code, service name, quota name, namespace, utilization percentage, default value, applied value, and whether the quota is adjustable. Up to 1,000 records are returned per page.

      Parameters:
      quotas - A list of quota utilization records, sorted by utilization percentage in descending order. Each record includes the quota code, service code, service name, quota name, namespace, utilization percentage, default value, applied value, and whether the quota is adjustable. Up to 1,000 records are returned per page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • quotas

      GetQuotaUtilizationReportResponse.Builder quotas(Consumer<QuotaUtilizationInfo.Builder>... quotas)

      A list of quota utilization records, sorted by utilization percentage in descending order. Each record includes the quota code, service code, service name, quota name, namespace, utilization percentage, default value, applied value, and whether the quota is adjustable. Up to 1,000 records are returned per page.

      This is a convenience method that creates an instance of the QuotaUtilizationInfo.Builder avoiding the need to create one manually via QuotaUtilizationInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to quotas(List<QuotaUtilizationInfo>).

      Parameters:
      quotas - a consumer that will call methods on QuotaUtilizationInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      GetQuotaUtilizationReportResponse.Builder nextToken(String nextToken)

      A token that indicates more results are available. Include this token in the next request to retrieve the next page of results. If this field is not present, you have retrieved all available results.

      Parameters:
      nextToken - A token that indicates more results are available. Include this token in the next request to retrieve the next page of results. If this field is not present, you have retrieved all available results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorCode

      GetQuotaUtilizationReportResponse.Builder errorCode(String errorCode)

      An error code indicating the reason for failure when the report status is FAILED. This field is only present when the status is FAILED.

      Parameters:
      errorCode - An error code indicating the reason for failure when the report status is FAILED. This field is only present when the status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorMessage

      GetQuotaUtilizationReportResponse.Builder errorMessage(String errorMessage)

      A detailed error message describing the failure when the report status is FAILED. This field is only present when the status is FAILED.

      Parameters:
      errorMessage - A detailed error message describing the failure when the report status is FAILED. This field is only present when the status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.