com.veeva.vault.sdk.api.document

Interface DocumentFieldCollectionRequest.Builder

Enclosing interface:

DocumentFieldCollectionRequest

public static interface DocumentFieldCollectionRequest.Builder

Creates an instance of DocumentFieldCollectionRequest.

Method Summary

Modifier and Type	Method and Description
DocumentFieldCollectionRequest	build() Validates and retrieves a completed DocumentFieldCollectionRequest.
DocumentFieldCollectionRequest.Builder	withDocumentType(DocumentType documentType) Required: Sets the DocumentType.
DocumentFieldCollectionRequest.Builder	withFieldFilter(DocumentFieldFilter fieldFilter) Optional: Sets the filter to apply for DocumentField bulk retrieval.
DocumentFieldCollectionRequest.Builder	withFieldNames(Set<String> fieldNames) Optional: Sets the field names.

Method Detail

withDocumentType

DocumentFieldCollectionRequest.Builder withDocumentType(DocumentType documentType)

Required: Sets the DocumentType.

Parameters:

documentType - the DocumentType. Cannot be null or empty. Document Type must exist.

Returns:

this DocumentFieldCollectionRequest.Builder

withFieldNames

DocumentFieldCollectionRequest.Builder withFieldNames(Set<String> fieldNames)

Optional: Sets the field names.

Parameters:

fieldNames - the set of names of the fields. Cannot be null or empty. Fields must exist. For example, name__v.

Returns:

this DocumentFieldCollectionRequest.Builder

withFieldFilter

DocumentFieldCollectionRequest.Builder withFieldFilter(DocumentFieldFilter fieldFilter)

Optional: Sets the filter to apply for DocumentField bulk retrieval. If omitted, retrieves all field metadata for the specified document type.

Parameters:

fieldFilter - the filter criteria to apply. Cannot be null or empty.

Returns:

this DocumentFieldCollectionRequest.Builder

build

DocumentFieldCollectionRequest build()

Validates and retrieves a completed DocumentFieldCollectionRequest.

Returns:

the completed DocumentFieldCollectionRequest