com.veeva.vault.sdk.api.data

Interface ObjectFieldCollectionRequest.Builder

Enclosing interface:

ObjectFieldCollectionRequest

public static interface ObjectFieldCollectionRequest.Builder

Creates an instance of ObjectFieldCollectionRequest.

Method Summary

Modifier and Type	Method and Description
ObjectFieldCollectionRequest	build() Validates and retrieves a completed ObjectFieldCollectionRequest.
ObjectFieldFilter.Builder	newFieldFilterBuilder() Creates an instance of ObjectFieldFilter.Builder.
ObjectFieldCollectionRequest.Builder	withFieldFilter(ObjectFieldFilter objectFieldFilter) Optional: Sets the filter to be applied for ObjectField bulk retrieval.
ObjectFieldCollectionRequest.Builder	withObjectName(String objectName) Deprecated. as of 23R1.3, see ObjectMetadataService.newFieldCollectionRequestBuilder()

Method Detail

withObjectName

ObjectFieldCollectionRequest.Builder withObjectName(String objectName)

Deprecated. as of 23R1.3, see ObjectMetadataService.newFieldCollectionRequestBuilder()

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 ObjectFieldCollectionRequest.Builder

withFieldFilter

ObjectFieldCollectionRequest.Builder withFieldFilter(ObjectFieldFilter objectFieldFilter)

Optional: Sets the filter to be applied for ObjectField bulk retrieval. If omitted, retrieves all field metadata for the specified object.

Parameters:

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

Returns:

this ObjectFieldCollectionRequest.Builder

newFieldFilterBuilder

ObjectFieldFilter.Builder newFieldFilterBuilder()

Creates an instance of ObjectFieldFilter.Builder.

Returns:

an ObjectFieldFilter.Builder

build

ObjectFieldCollectionRequest build()

Validates and retrieves a completed ObjectFieldCollectionRequest.

Returns:

the completed ObjectFieldCollectionRequest