Interface ChangeSummary.Builder

  • Method Details

    • changeType

      ChangeSummary.Builder changeType(String changeType)

      The type of the change.

      Parameters:
      changeType - The type of the change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • entity

      ChangeSummary.Builder entity(Entity entity)

      The entity to be changed.

      Parameters:
      entity - The entity to be changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • entity

      default ChangeSummary.Builder entity(Consumer<Entity.Builder> entity)

      The entity to be changed.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to entity(Entity).

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

      ChangeSummary.Builder details(String details)

      This object contains details specific to the change type of the requested change.

      Parameters:
      details - This object contains details specific to the change type of the requested change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • detailsDocument

      ChangeSummary.Builder detailsDocument(Document detailsDocument)

      The JSON value of the details specific to the change type of the requested change.

      Parameters:
      detailsDocument - The JSON value of the details specific to the change type of the requested change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • errorDetailList

      ChangeSummary.Builder errorDetailList(Collection<ErrorDetail> errorDetailList)

      An array of ErrorDetail objects associated with the change.

      Parameters:
      errorDetailList - An array of ErrorDetail objects associated with the change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • errorDetailList

      ChangeSummary.Builder errorDetailList(ErrorDetail... errorDetailList)

      An array of ErrorDetail objects associated with the change.

      Parameters:
      errorDetailList - An array of ErrorDetail objects associated with the change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • errorDetailList

      ChangeSummary.Builder errorDetailList(Consumer<ErrorDetail.Builder>... errorDetailList)

      An array of ErrorDetail objects associated with the change.

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

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

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

      ChangeSummary.Builder changeName(String changeName)

      Optional name for the change.

      Parameters:
      changeName - Optional name for the change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.