Package com.veeva.vault.sdk.api.data

Interface ObjectFieldMetadataCollectionRequest.Builder

Enclosing interface:

ObjectFieldMetadataCollectionRequest

public static interface ObjectFieldMetadataCollectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
ObjectFieldMetadataCollectionRequest	build()	Validates and retrieves a completed ObjectFieldMetadataCollectionRequest.
ObjectFieldMetadataCollectionRequest.Builder	withFieldNames(List<String> fieldNames)	Optional: Sets a filter to retrieve field metadata with the specified names.
ObjectFieldMetadataCollectionRequest.Builder	withObjectName(String objectName)	Required: Sets the object name.
ObjectFieldMetadataCollectionRequest.Builder	withRequiredOnly()	Optional: Sets a filter to retrieve required field attributes only.
ObjectFieldMetadataCollectionRequest.Builder	withUniqueOnly()	Optional: Sets a filter to retrieve unique field attributes only.

Method Details

withObjectName

ObjectFieldMetadataCollectionRequest.Builder withObjectName(String objectName)

Required: Sets the object name.

Parameters:

objectName - the name of the object. Cannot be null or empty. Object must exist. For example, "product__v".

Returns:

this ObjectFieldMetadataCollectionRequest.Builder

withFieldNames

ObjectFieldMetadataCollectionRequest.Builder withFieldNames(List<String> fieldNames)

Optional: Sets a filter to retrieve field metadata with the specified names. When omitted, retrieves all field attributes.

Parameters:

fieldNames - the List of field names. Cannot be null or empty.

Returns:

this ObjectFieldMetadataCollectionRequest.Builder

withRequiredOnly

ObjectFieldMetadataCollectionRequest.Builder withRequiredOnly()

Optional: Sets a filter to retrieve required field attributes only. When omitted, retrieves all field attributes.

Returns:

this ObjectFieldMetadataCollectionRequest.Builder

withUniqueOnly

ObjectFieldMetadataCollectionRequest.Builder withUniqueOnly()

Optional: Sets a filter to retrieve unique field attributes only. When omitted, retrieves all field attributes.

Returns:

this ObjectFieldMetadataCollectionRequest.Builder

build

ObjectFieldMetadataCollectionRequest build()

Validates and retrieves a completed ObjectFieldMetadataCollectionRequest.

Returns:

the completed ObjectFieldMetadataCollectionRequest