Interface DocumentAttributeTarget.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DocumentAttributeTarget.Builder,DocumentAttributeTarget>, SdkBuilder<DocumentAttributeTarget.Builder,DocumentAttributeTarget>, SdkPojo
Enclosing class:
DocumentAttributeTarget
public static interface DocumentAttributeTarget.Builder extends SdkPojo, CopyableBuilder<DocumentAttributeTarget.Builder,DocumentAttributeTarget>

  • Method Details

    • targetDocumentAttributeKey

      DocumentAttributeTarget.Builder targetDocumentAttributeKey(String targetDocumentAttributeKey)

      The identifier of the target document attribute or metadata field.

      For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

      Parameters:
      targetDocumentAttributeKey - The identifier of the target document attribute or metadata field.

      For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

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

    • targetDocumentAttributeValueDeletion

      DocumentAttributeTarget.Builder targetDocumentAttributeValueDeletion(Boolean targetDocumentAttributeValueDeletion)

      TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value ( TargetDocumentAttributeValue), set this to FALSE.

      Parameters:
      targetDocumentAttributeValueDeletion - TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value ( TargetDocumentAttributeValue), set this to FALSE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetDocumentAttributeValue

      DocumentAttributeTarget.Builder targetDocumentAttributeValue(DocumentAttributeValue targetDocumentAttributeValue)

      The target value you want to create for the target attribute.

      For example, 'Finance' could be the target value for the target attribute key 'Department'.

      Parameters:
      targetDocumentAttributeValue - The target value you want to create for the target attribute.

      For example, 'Finance' could be the target value for the target attribute key 'Department'.

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

    • targetDocumentAttributeValue

      default DocumentAttributeTarget.Builder targetDocumentAttributeValue(Consumer<DocumentAttributeValue.Builder> targetDocumentAttributeValue)

      The target value you want to create for the target attribute.

      For example, 'Finance' could be the target value for the target attribute key 'Department'.

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

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

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