Interface AuditEvent.Builder

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

  • Method Details

    • eventId

      AuditEvent.Builder eventId(String eventId)

      Unique identifier of a case audit history event.

      Parameters:
      eventId - Unique identifier of a case audit history event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      AuditEvent.Builder type(String type)

      The type of audit history event.

      Valid Values: Case.Created | Case.Updated | RelatedItem.Created | RelatedItem.Updated | RelatedItem.Deleted

      Parameters:
      type - The type of audit history event.

      Valid Values: Case.Created | Case.Updated | RelatedItem.Created | RelatedItem.Updated | RelatedItem.Deleted

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

    • type

      AuditEvent.Builder type(AuditEventType type)

      The type of audit history event.

      Valid Values: Case.Created | Case.Updated | RelatedItem.Created | RelatedItem.Updated | RelatedItem.Deleted

      Parameters:
      type - The type of audit history event.

      Valid Values: Case.Created | Case.Updated | RelatedItem.Created | RelatedItem.Updated | RelatedItem.Deleted

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

    • relatedItemType

      AuditEvent.Builder relatedItemType(String relatedItemType)

      The Type of the related item.

      Parameters:
      relatedItemType - The Type of the related item.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • relatedItemType

      AuditEvent.Builder relatedItemType(RelatedItemType relatedItemType)

      The Type of the related item.

      Parameters:
      relatedItemType - The Type of the related item.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • performedTime

      AuditEvent.Builder performedTime(Instant performedTime)

      Time at which an Audit History event took place.

      Parameters:
      performedTime - Time at which an Audit History event took place.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fields

      AuditEvent.Builder fields(Collection<AuditEventField> fields)

      A list of Case Audit History event fields.

      Parameters:
      fields - A list of Case Audit History event fields.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fields

      AuditEvent.Builder fields(AuditEventField... fields)

      A list of Case Audit History event fields.

      Parameters:
      fields - A list of Case Audit History event fields.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fields

      AuditEvent.Builder fields(Consumer<AuditEventField.Builder>... fields)

      A list of Case Audit History event fields.

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

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

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

    • performedBy

      AuditEvent.Builder performedBy(AuditEventPerformedBy performedBy)

      Information of the user which performed the audit.

      Parameters:
      performedBy - Information of the user which performed the audit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • performedBy

      default AuditEvent.Builder performedBy(Consumer<AuditEventPerformedBy.Builder> performedBy)

      Information of the user which performed the audit.

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

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

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