PutDocumentsRequest.Builder

public final class PutDocumentsRequest.Builder


Builder for PutDocumentsRequest objects.

Summary

Public constructors

Public methods

@NonNull PutDocumentsRequest.Builder
addDocuments(@NonNull Object[] documents)

Adds one or more annotated androidx.appsearch.annotation.Document documents to the request.

@NonNull PutDocumentsRequest.Builder

Adds a collection of annotated androidx.appsearch.annotation.Document documents to the request.

@NonNull PutDocumentsRequest.Builder
addGenericDocuments(@NonNull GenericDocument[] documents)

Adds one or more GenericDocument objects to the request.

@NonNull PutDocumentsRequest.Builder

Adds a collection of GenericDocument objects to the request.

@NonNull PutDocumentsRequest

Creates a new PutDocumentsRequest object.

Public constructors

Builder

Added in 1.1.0-alpha04
public Builder()

Public methods

addDocuments

public @NonNull PutDocumentsRequest.Builder addDocuments(@NonNull Object[] documents)

Adds one or more annotated androidx.appsearch.annotation.Document documents to the request.

Parameters
@NonNull Object[] documents

annotated androidx.appsearch.annotation.Document documents.

Throws
androidx.appsearch.exceptions.AppSearchException

if an error occurs converting a document class into a GenericDocument.

addDocuments

Added in 1.1.0-alpha04
public @NonNull PutDocumentsRequest.Builder addDocuments(@NonNull Collection<Object> documents)

Adds a collection of annotated androidx.appsearch.annotation.Document documents to the request.

Parameters
@NonNull Collection<Object> documents

annotated androidx.appsearch.annotation.Document documents.

Throws
androidx.appsearch.exceptions.AppSearchException

if an error occurs converting a document into a GenericDocument.

addGenericDocuments

public @NonNull PutDocumentsRequest.Builder addGenericDocuments(@NonNull GenericDocument[] documents)

Adds one or more GenericDocument objects to the request.

addGenericDocuments

Added in 1.1.0-alpha04
public @NonNull PutDocumentsRequest.Builder addGenericDocuments(@NonNull Collection<GenericDocument> documents)

Adds a collection of GenericDocument objects to the request.

build

Added in 1.1.0-alpha04
public @NonNull PutDocumentsRequest build()

Creates a new PutDocumentsRequest object.