Package com.coveo.pushapiclient

Class Source

java.lang.Object

com.coveo.pushapiclient.Source

public class Source
extends Object

Constructor Summary

Constructors

Constructor	Description
Source(String apiKey, String organizationId)
Source(String apiKey, String organizationId, Environment environment)	Deprecated. Please now use PlatformUrl to define your Platform environment
Source(String apiKey, String organizationId, PlatformUrl platformUrl)

Method Summary

Modifier and Type	Method	Description
HttpResponse<String>	addOrUpdateDocument(String sourceId, DocumentBuilder docBuilder)	Adds or updates an individual item in a push source.
HttpResponse<String>	batchUpdateDocuments(String sourceId, BatchUpdate batchUpdate)	Manage batches of items in a push source.
SecurityIdentityBatchResponse	batchUpdateSecurityIdentities(String securityProviderId, BatchIdentity batchIdentity)	Manages pushing batches of Security Identities to a File Container, then into Coveo.
HttpResponse<String>	create(String name, SourceVisibility sourceVisibility)	Create a new push source.
FileContainer	createFileContainer()	Creates a File Container.
HttpResponse<String>	createOrUpdateSecurityIdentity(String securityProviderId, SecurityIdentityModel securityIdentityModel)	Create or update a security identity.
HttpResponse<String>	createOrUpdateSecurityIdentityAlias(String securityProviderId, SecurityIdentityAliasModel securityIdentityAliasModel)	Create or update a security identity alias.
HttpResponse<String>	deleteDocument(String sourceId, String documentId, Boolean deleteChildren)	Deletes a specific item from a Push source.
HttpResponse<String>	deleteOldSecurityIdentities(String securityProviderId, SecurityIdentityDeleteOptions batchDelete)	Delete old security identities.
HttpResponse<String>	deleteSecurityIdentity(String securityProviderId, SecurityIdentityDelete securityIdentityDelete)	Delete a security identity.
HttpResponse<String>	manageSecurityIdentities(String securityProviderId, SecurityIdentityBatchConfig batchConfig)	Manage batches of security identities.
HttpResponse<String>	pushBinaryToFileContainer(FileContainer fileContainer, byte[] fileAsBytes)	Push file to a File Container.
HttpResponse<String>	updateSourceStatus(String sourceId, PushAPIStatus status)	Update the status of a Push source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Source

public Source(String apiKey,
 String organizationId)

Parameters:

apiKey - An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).

organizationId - The Coveo Organization identifier.

Source

public Source(String apiKey,
 String organizationId,
 PlatformUrl platformUrl)

Parameters:

apiKey - An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).

organizationId - The Coveo Organization identifier.

platformUrl -

Source

@Deprecated
public Source(String apiKey,
 String organizationId,
 Environment environment)

Deprecated.

Please now use PlatformUrl to define your Platform environment

Parameters:

apiKey - An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).

organizationId - The Coveo Organization identifier.

environment - The Environment to be used.

See Also:

• Construct a PlatformUrl

Method Details

create

public HttpResponse<String> create(String name,
 SourceVisibility sourceVisibility)
                            throws IOException,
InterruptedException

Create a new push source.

Parameters:

name - The name of the source to create

sourceVisibility - The security option that should be applied to the content of the source. See [Content Security](https://docs.coveo.com/en/1779).

Returns:

Throws:

IOException

InterruptedException

createOrUpdateSecurityIdentity

public HttpResponse<String> createOrUpdateSecurityIdentity(String securityProviderId,
 SecurityIdentityModel securityIdentityModel)
                                                    throws IOException,
InterruptedException

Create or update a security identity. See [Adding a Single Security Identity](https://docs.coveo.com/en/167) and [Security Identity Models](https://docs.coveo.com/en/139).

Parameters:

securityProviderId -

securityIdentityModel -

Returns:

Throws:

IOException

InterruptedException

createOrUpdateSecurityIdentityAlias

public HttpResponse<String> createOrUpdateSecurityIdentityAlias(String securityProviderId,
 SecurityIdentityAliasModel securityIdentityAliasModel)
                                                         throws IOException,
InterruptedException

Create or update a security identity alias. See [Adding a Single Alias](https://docs.coveo.com/en/142) and [User Alias Definition Examples](https://docs.coveo.com/en/46).

Parameters:

securityProviderId -

securityIdentityAliasModel -

Returns:

Throws:

IOException

InterruptedException

deleteSecurityIdentity

public HttpResponse<String> deleteSecurityIdentity(String securityProviderId,
 SecurityIdentityDelete securityIdentityDelete)
                                            throws IOException,
InterruptedException

Delete a security identity. See [Disabling a Single Security Identity](https://docs.coveo.com/en/84).

Parameters:

securityProviderId -

securityIdentityDelete -

Returns:

Throws:

IOException

InterruptedException

updateSourceStatus

public HttpResponse<String> updateSourceStatus(String sourceId,
 PushAPIStatus status)
                                        throws IOException,
InterruptedException

Update the status of a Push source. See [Updating the Status of a Push Source](https://docs.coveo.com/en/35).

Parameters:

sourceId -

status -

Returns:

Throws:

IOException

InterruptedException

deleteOldSecurityIdentities

public HttpResponse<String> deleteOldSecurityIdentities(String securityProviderId,
 SecurityIdentityDeleteOptions batchDelete)
                                                 throws IOException,
InterruptedException

Delete old security identities. See [Disabling Old Security Identities](https://docs.coveo.com/en/33).

Parameters:

securityProviderId -

batchDelete -

Returns:

Throws:

IOException

InterruptedException

manageSecurityIdentities

public HttpResponse<String> manageSecurityIdentities(String securityProviderId,
 SecurityIdentityBatchConfig batchConfig)
                                              throws IOException,
InterruptedException

Manage batches of security identities. See [Manage Batches of Security Identities](https://docs.coveo.com/en/55).

Parameters:

securityProviderId -

batchConfig -

Returns:

Throws:

IOException

InterruptedException

addOrUpdateDocument

public HttpResponse<String> addOrUpdateDocument(String sourceId,
 DocumentBuilder docBuilder)
                                         throws IOException,
InterruptedException

Adds or updates an individual item in a push source. See [Adding a Single Item in a Push Source](https://docs.coveo.com/en/133).

Parameters:

sourceId -

docBuilder -

Returns:

Throws:

IOException

InterruptedException

deleteDocument

public HttpResponse<String> deleteDocument(String sourceId,
 String documentId,
 Boolean deleteChildren)
                                    throws IOException,
InterruptedException

Deletes a specific item from a Push source. Optionally, the child items of that item can also be deleted. See [Deleting an Item in a Push Source](https://docs.coveo.com/en/171).

Parameters:

sourceId -

documentId -

deleteChildren -

Returns:

Throws:

IOException

InterruptedException

batchUpdateDocuments

public HttpResponse<String> batchUpdateDocuments(String sourceId,
 BatchUpdate batchUpdate)
                                          throws IOException,
InterruptedException

Manage batches of items in a push source. See [Manage Batches of Items in a Push Source](https://docs.coveo.com/en/90)

Parameters:

sourceId -

batchUpdate -

Returns:

Throws:

IOException

InterruptedException

batchUpdateSecurityIdentities

public SecurityIdentityBatchResponse batchUpdateSecurityIdentities(String securityProviderId,
 BatchIdentity batchIdentity)
                                                            throws IOException,
InterruptedException

Manages pushing batches of Security Identities to a File Container, then into Coveo. See [Manage Batches of Security Identities](https://docs.coveo.com/en/55)

Parameters:

securityProviderId -

batchIdentity -

Returns:

Throws:

IOException

InterruptedException

createFileContainer

public FileContainer createFileContainer()
                                  throws IOException,
InterruptedException

Creates a File Container. [Creating a File Container](https://docs.coveo.com/en/43)

Returns:

Throws:

IOException

InterruptedException

pushBinaryToFileContainer

public HttpResponse<String> pushBinaryToFileContainer(FileContainer fileContainer,
 byte[] fileAsBytes)
                                               throws IOException,
InterruptedException

Push file to a File Container. [Using the compressedBinaryDataFileId Property](https://docs.coveo.com/en/69)

Parameters:

fileContainer -

fileAsBytes -

Returns:

Throws:

IOException

InterruptedException