Index
All Classes and Interfaces|All Packages
A
- additionalInfo - Variable in class com.coveo.pushapiclient.IdentityModel
- addOrUpdateDocument(String, DocumentBuilder) - Method in class com.coveo.pushapiclient.Source
-
Adds or updates an individual item in a push source.
- AliasMapping - Class in com.coveo.pushapiclient
- AliasMapping(String, String, SecurityIdentityType, Map<String, String>) - Constructor for class com.coveo.pushapiclient.AliasMapping
- allowAnonymous - Variable in class com.coveo.pushapiclient.DocumentPermissions
-
Whether to allow anonymous users in this permission set.
- allowedPermissions - Variable in class com.coveo.pushapiclient.DocumentPermissions
-
The list of allowed permissions for this permission set.
- AnySecurityIdentityBuilder - Class in com.coveo.pushapiclient
- AnySecurityIdentityBuilder(String[], SecurityIdentityType, String) - Constructor for class com.coveo.pushapiclient.AnySecurityIdentityBuilder
- AnySecurityIdentityBuilder(String, SecurityIdentityType, String) - Constructor for class com.coveo.pushapiclient.AnySecurityIdentityBuilder
- appendOrderingId(long) - Method in class com.coveo.pushapiclient.PlatformClient
-
Returns the orderingId for the query string only when a valid orderingId is available.
- AU - Enum constant in enum com.coveo.pushapiclient.Region
- author - Variable in class com.coveo.pushapiclient.Document
-
The author of the document.
B
- BatchIdentity - Class in com.coveo.pushapiclient
-
See [Manage Batches of Security Identities](https://docs.coveo.com/en/55)
- BatchIdentity(List<SecurityIdentityModel>, List<SecurityIdentityAliasModel>, List<IdentityModel>) - Constructor for class com.coveo.pushapiclient.BatchIdentity
- BatchIdentityRecord - Class in com.coveo.pushapiclient
-
See [BatchIdentityBody](https://docs.coveo.com/en/139#batchidentitybody)
- BatchIdentityRecord(JsonObject[], JsonObject[], JsonObject[]) - Constructor for class com.coveo.pushapiclient.BatchIdentityRecord
- batchResponse - Variable in class com.coveo.pushapiclient.SecurityIdentityBatchResponse
- BatchUpdate - Class in com.coveo.pushapiclient
-
See [Manage Batches of Items in a Push Source](https://docs.coveo.com/en/90)
- BatchUpdate(List<DocumentBuilder>, List<DeleteDocument>) - Constructor for class com.coveo.pushapiclient.BatchUpdate
- batchUpdateDocuments(String, BatchUpdate) - Method in class com.coveo.pushapiclient.Source
-
Manage batches of items in a push source.
- BatchUpdateRecord - Class in com.coveo.pushapiclient
-
See [BatchDocumentBody](https://docs.coveo.com/en/75/#batchdocumentbody)
- BatchUpdateRecord(JsonObject[], JsonObject[]) - Constructor for class com.coveo.pushapiclient.BatchUpdateRecord
- batchUpdateSecurityIdentities(String, BatchIdentity) - Method in class com.coveo.pushapiclient.Source
-
Manages pushing batches of Security Identities to a File Container, then into Coveo.
- build() - Method in class com.coveo.pushapiclient.AnySecurityIdentityBuilder
- build() - Method in class com.coveo.pushapiclient.GroupSecurityIdentityBuilder
- build() - Method in class com.coveo.pushapiclient.PlatformUrlBuilder
- build() - Method in interface com.coveo.pushapiclient.SecurityIdentityBuilder
-
Build and return a list of
SecurityIdentity - build() - Method in class com.coveo.pushapiclient.UserSecurityIdentityBuilder
- build() - Method in class com.coveo.pushapiclient.VirtualGroupSecurityIdentityBuilder
C
- clickableUri - Variable in class com.coveo.pushapiclient.Document
-
The clickable URI associated with the document.
- com.coveo.pushapiclient - package com.coveo.pushapiclient
- compressedBinaryData - Variable in class com.coveo.pushapiclient.Document
-
The original binary item content, compressed using one of the supported compression types (Deflate, GZip, LZMA, Uncompressed, or ZLib), and then Base64 encoded.
- CompressedBinaryData - Class in com.coveo.pushapiclient
-
The original binary item content, compressed using one of the supported compression types (Deflate, GZip, LZMA, Uncompressed, or ZLib), and then Base64 encoded.
- CompressedBinaryData(String, CompressionType) - Constructor for class com.coveo.pushapiclient.CompressedBinaryData
- compressedBinaryDataFileId - Variable in class com.coveo.pushapiclient.Document
-
The fileId from the content that has been uploaded to the S3 via a FileContainer.
- CompressionType - Enum in com.coveo.pushapiclient
-
The compression type that was applied to your compressed document.
- create(String, SourceVisibility) - Method in class com.coveo.pushapiclient.Source
-
Create a new push source.
- createFileContainer() - Method in class com.coveo.pushapiclient.PlatformClient
-
Create a file container.
- createFileContainer() - Method in class com.coveo.pushapiclient.Source
-
Creates a File Container.
- createOrUpdateSecurityIdentity(String, SecurityIdentityModel) - Method in class com.coveo.pushapiclient.PlatformClient
-
Create or update a security identity.
- createOrUpdateSecurityIdentity(String, SecurityIdentityModel) - Method in class com.coveo.pushapiclient.Source
-
Create or update a security identity.
- createOrUpdateSecurityIdentityAlias(String, SecurityIdentityAliasModel) - Method in class com.coveo.pushapiclient.PlatformClient
-
Create or update a security identity alias.
- createOrUpdateSecurityIdentityAlias(String, SecurityIdentityAliasModel) - Method in class com.coveo.pushapiclient.Source
-
Create or update a security identity alias.
- createSource(String, SourceVisibility) - Method in class com.coveo.pushapiclient.PlatformClient
-
Create a new push source
D
- data - Variable in class com.coveo.pushapiclient.Document
-
The textual (non-binary) content of the item.
- date - Variable in class com.coveo.pushapiclient.Document
-
The date of the document, represented as an ISO string.
- DEFAULT_ENVIRONMENT - Static variable in class com.coveo.pushapiclient.PlatformUrl
- DEFAULT_REGION - Static variable in class com.coveo.pushapiclient.PlatformUrl
- DEFLATE - Enum constant in enum com.coveo.pushapiclient.CompressionType
- deleteChildren - Variable in class com.coveo.pushapiclient.DeleteDocument
-
Flag to delete children of the document.
- deleteDocument(String, String, Boolean) - Method in class com.coveo.pushapiclient.PlatformClient
-
Deletes a specific item from a Push source.
- deleteDocument(String, String, Boolean) - Method in class com.coveo.pushapiclient.Source
-
Deletes a specific item from a Push source.
- DeleteDocument - Class in com.coveo.pushapiclient
- DeleteDocument(String) - Constructor for class com.coveo.pushapiclient.DeleteDocument
- DeleteDocument(String, boolean) - Constructor for class com.coveo.pushapiclient.DeleteDocument
- deleteOldSecurityIdentities(String, SecurityIdentityDeleteOptions) - Method in class com.coveo.pushapiclient.PlatformClient
-
Delete old security identities.
- deleteOldSecurityIdentities(String, SecurityIdentityDeleteOptions) - Method in class com.coveo.pushapiclient.Source
-
Delete old security identities.
- deleteSecurityIdentity(String, SecurityIdentityDelete) - Method in class com.coveo.pushapiclient.PlatformClient
-
Delete a security identity.
- deleteSecurityIdentity(String, SecurityIdentityDelete) - Method in class com.coveo.pushapiclient.Source
-
Delete a security identity.
- deniedPermissions - Variable in class com.coveo.pushapiclient.DocumentPermissions
-
The list of denied permissions for this permission set.
- DEVELOPMENT - Enum constant in enum com.coveo.pushapiclient.Environment
- Document - Class in com.coveo.pushapiclient
- Document() - Constructor for class com.coveo.pushapiclient.Document
- DocumentBuilder - Class in com.coveo.pushapiclient
-
Utility class to build a
Document - DocumentBuilder(String, String) - Constructor for class com.coveo.pushapiclient.DocumentBuilder
- documentId - Variable in class com.coveo.pushapiclient.DeleteDocument
-
The documentId of the document.
- documentId - Variable in class com.coveo.pushapiclient.Document
-
The documentId of the document.
- DocumentPermissions - Class in com.coveo.pushapiclient
- DocumentPermissions() - Constructor for class com.coveo.pushapiclient.DocumentPermissions
E
- Environment - Enum in com.coveo.pushapiclient
-
Available environments to use as the host for the PushAPI.
- equals(Object) - Method in class com.coveo.pushapiclient.BatchUpdate
- equals(Object) - Method in class com.coveo.pushapiclient.BatchUpdateRecord
- equals(Object) - Method in class com.coveo.pushapiclient.CompressedBinaryData
- equals(Object) - Method in class com.coveo.pushapiclient.GroupSecurityIdentityBuilder
- equals(Object) - Method in class com.coveo.pushapiclient.SecurityIdentityBatchConfig
- equals(Object) - Method in class com.coveo.pushapiclient.SecurityIdentityDelete
- equals(Object) - Method in class com.coveo.pushapiclient.SecurityIdentityDeleteOptions
- equals(Object) - Method in class com.coveo.pushapiclient.UserSecurityIdentityBuilder
- equals(Object) - Method in class com.coveo.pushapiclient.VirtualGroupSecurityIdentityBuilder
- EU - Enum constant in enum com.coveo.pushapiclient.Region
F
- FileContainer - Class in com.coveo.pushapiclient
-
See [Creating a FileContainer](https://docs.coveo.com/en/43)
- FileContainer() - Constructor for class com.coveo.pushapiclient.FileContainer
- fileExtension - Variable in class com.coveo.pushapiclient.Document
-
The file extension of the data you're pushing.
- fileId - Variable in class com.coveo.pushapiclient.FileContainer
G
- getAddOrUpdate() - Method in class com.coveo.pushapiclient.BatchUpdate
- getAddOrUpdate() - Method in class com.coveo.pushapiclient.BatchUpdateRecord
- getApiUrl() - Method in class com.coveo.pushapiclient.PlatformUrl
- getBatchResponse() - Method in class com.coveo.pushapiclient.SecurityIdentityBatchResponse
- getCompressionType() - Method in class com.coveo.pushapiclient.CompressedBinaryData
- getData() - Method in class com.coveo.pushapiclient.CompressedBinaryData
- getDelete() - Method in class com.coveo.pushapiclient.BatchUpdate
- getDelete() - Method in class com.coveo.pushapiclient.BatchUpdateRecord
- getDeleted() - Method in class com.coveo.pushapiclient.BatchIdentity
- getDeleted() - Method in class com.coveo.pushapiclient.BatchIdentityRecord
- getDocument() - Method in class com.coveo.pushapiclient.DocumentBuilder
- getFileId() - Method in class com.coveo.pushapiclient.SecurityIdentityBatchConfig
- getIdentities() - Method in class com.coveo.pushapiclient.GroupSecurityIdentityBuilder
- getIdentities() - Method in class com.coveo.pushapiclient.UserSecurityIdentityBuilder
- getIdentities() - Method in class com.coveo.pushapiclient.VirtualGroupSecurityIdentityBuilder
- getIdentity() - Method in class com.coveo.pushapiclient.SecurityIdentityDelete
- getMappings() - Method in class com.coveo.pushapiclient.BatchIdentity
- getMappings() - Method in class com.coveo.pushapiclient.BatchIdentityRecord
- getMembers() - Method in class com.coveo.pushapiclient.BatchIdentity
- getMembers() - Method in class com.coveo.pushapiclient.BatchIdentityRecord
- getOrderingId() - Method in class com.coveo.pushapiclient.SecurityIdentityBatchConfig
- getOrderingId() - Method in class com.coveo.pushapiclient.SecurityIdentityDeleteOptions
- getPlatformUrl() - Method in class com.coveo.pushapiclient.PlatformUrl
- getQueueDelay() - Method in class com.coveo.pushapiclient.SecurityIdentityDeleteOptions
- getS3Response() - Method in class com.coveo.pushapiclient.SecurityIdentityBatchResponse
- getSecurityProvider() - Method in class com.coveo.pushapiclient.GroupSecurityIdentityBuilder
- getSecurityProvider() - Method in class com.coveo.pushapiclient.UserSecurityIdentityBuilder
- getSecurityProvider() - Method in class com.coveo.pushapiclient.VirtualGroupSecurityIdentityBuilder
- getValue() - Method in enum com.coveo.pushapiclient.Environment
- getValue() - Method in enum com.coveo.pushapiclient.Region
- GROUP - Enum constant in enum com.coveo.pushapiclient.SecurityIdentityType
- GroupSecurityIdentityBuilder - Class in com.coveo.pushapiclient
-
Build a security identity of type `GROUP`.
- GroupSecurityIdentityBuilder(String[], String) - Constructor for class com.coveo.pushapiclient.GroupSecurityIdentityBuilder
- GroupSecurityIdentityBuilder(String, String) - Constructor for class com.coveo.pushapiclient.GroupSecurityIdentityBuilder
-
Construct a GroupSecurityIdentityBuilder with a single identity
- GZIP - Enum constant in enum com.coveo.pushapiclient.CompressionType
H
- hashCode() - Method in class com.coveo.pushapiclient.BatchUpdate
- hashCode() - Method in class com.coveo.pushapiclient.BatchUpdateRecord
- hashCode() - Method in class com.coveo.pushapiclient.CompressedBinaryData
- hashCode() - Method in class com.coveo.pushapiclient.GroupSecurityIdentityBuilder
- hashCode() - Method in class com.coveo.pushapiclient.SecurityIdentityBatchConfig
- hashCode() - Method in class com.coveo.pushapiclient.SecurityIdentityDelete
- hashCode() - Method in class com.coveo.pushapiclient.SecurityIdentityDeleteOptions
- hashCode() - Method in class com.coveo.pushapiclient.UserSecurityIdentityBuilder
- hashCode() - Method in class com.coveo.pushapiclient.VirtualGroupSecurityIdentityBuilder
- HIPAA - Enum constant in enum com.coveo.pushapiclient.Environment
I
- identity - Variable in class com.coveo.pushapiclient.SecurityIdentity
-
The name of the security identity.
- identity - Variable in class com.coveo.pushapiclient.SecurityIdentityModelBase
- IdentityModel - Class in com.coveo.pushapiclient
- IdentityModel(String, SecurityIdentityType, Map<String, String>) - Constructor for class com.coveo.pushapiclient.IdentityModel
- identityType - Variable in class com.coveo.pushapiclient.SecurityIdentity
-
The type of the identity.
- IDLE - Enum constant in enum com.coveo.pushapiclient.PushAPIStatus
- INCREMENTAL - Enum constant in enum com.coveo.pushapiclient.PushAPIStatus
L
- LZMA - Enum constant in enum com.coveo.pushapiclient.CompressionType
M
- manageSecurityIdentities(String, SecurityIdentityBatchConfig) - Method in class com.coveo.pushapiclient.PlatformClient
-
Manage batches of security identities.
- manageSecurityIdentities(String, SecurityIdentityBatchConfig) - Method in class com.coveo.pushapiclient.Source
-
Manage batches of security identities.
- mappings - Variable in class com.coveo.pushapiclient.SecurityIdentityAliasModel
- marshal() - Method in class com.coveo.pushapiclient.BatchIdentity
- marshal() - Method in class com.coveo.pushapiclient.BatchUpdate
- marshal() - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Marshal the document into a JSON string accepted by the push API.
- marshalJsonObject() - Method in class com.coveo.pushapiclient.DeleteDocument
- marshalJsonObject() - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Marshal the document into a JSON object accepted by the push API.
- members - Variable in class com.coveo.pushapiclient.SecurityIdentityModel
- metadata - Variable in class com.coveo.pushapiclient.Document
-
The metadata key-value pairs for a given document.
- modifiedDate - Variable in class com.coveo.pushapiclient.Document
-
The modified date of the document, represented as an ISO string.
N
- name - Variable in class com.coveo.pushapiclient.IdentityModel
P
- parentId - Variable in class com.coveo.pushapiclient.Document
-
The unique identifier (URI) of the parent item.
- permanentId - Variable in class com.coveo.pushapiclient.Document
-
The permanent identifier of a document that does not change over time.
- permissions - Variable in class com.coveo.pushapiclient.Document
-
The list of permission sets for this item.
- PlatformClient - Class in com.coveo.pushapiclient
-
PlatformClient handles network requests to the Coveo platform
- PlatformClient(String, String) - Constructor for class com.coveo.pushapiclient.PlatformClient
-
Construct a PlatformClient
- PlatformClient(String, String, Environment) - Constructor for class com.coveo.pushapiclient.PlatformClient
-
Deprecated.Please now use PlatformUrl to define your Platform environment
- PlatformClient(String, String, PlatformUrl) - Constructor for class com.coveo.pushapiclient.PlatformClient
-
Construct a PlatformClient
- PlatformClient(String, String, HttpClient) - Constructor for class com.coveo.pushapiclient.PlatformClient
-
Construct a PlatformClient
- PlatformUrl - Class in com.coveo.pushapiclient
- PlatformUrl(Environment, Region) - Constructor for class com.coveo.pushapiclient.PlatformUrl
- PlatformUrlBuilder - Class in com.coveo.pushapiclient
- PlatformUrlBuilder() - Constructor for class com.coveo.pushapiclient.PlatformUrlBuilder
- PRIVATE - Enum constant in enum com.coveo.pushapiclient.SourceVisibility
-
Items can be accessed by the source owner only.
- PRODUCTION - Enum constant in enum com.coveo.pushapiclient.Environment
- provider - Variable in class com.coveo.pushapiclient.AliasMapping
- PushAPIStatus - Enum in com.coveo.pushapiclient
-
Enum for possible PushAPI statuses.
- pushBinaryToFileContainer(FileContainer, byte[]) - Method in class com.coveo.pushapiclient.PlatformClient
-
Push a binary to a File Container.
- pushBinaryToFileContainer(FileContainer, byte[]) - Method in class com.coveo.pushapiclient.Source
-
Push file to a File Container.
- pushDocument(String, String, String, CompressionType) - Method in class com.coveo.pushapiclient.PlatformClient
-
Adds or updates an individual item in a push source.
- pushFileContainerContent(String, FileContainer) - Method in class com.coveo.pushapiclient.PlatformClient
-
Push a file container into a push source.
R
- REBUILD - Enum constant in enum com.coveo.pushapiclient.PushAPIStatus
- REFRESH - Enum constant in enum com.coveo.pushapiclient.PushAPIStatus
- Region - Enum in com.coveo.pushapiclient
-
Available Platform regions to connect to
- requiredHeaders - Variable in class com.coveo.pushapiclient.FileContainer
S
- s3Response - Variable in class com.coveo.pushapiclient.SecurityIdentityBatchResponse
- SECURED - Enum constant in enum com.coveo.pushapiclient.SourceVisibility
-
Items can be accessed by allowed users only.
- SecurityIdentity - Class in com.coveo.pushapiclient
- SecurityIdentity(String, SecurityIdentityType, String) - Constructor for class com.coveo.pushapiclient.SecurityIdentity
- SecurityIdentityAliasModel - Class in com.coveo.pushapiclient
-
See [User Alias Definition Examples](https://docs.coveo.com/en/46).
- SecurityIdentityAliasModel(AliasMapping[], IdentityModel, IdentityModel[]) - Constructor for class com.coveo.pushapiclient.SecurityIdentityAliasModel
- SecurityIdentityBatchConfig - Class in com.coveo.pushapiclient
-
See [Manage Batches of Security Identities](https://docs.coveo.com/en/55).
- SecurityIdentityBatchConfig(String, Long) - Constructor for class com.coveo.pushapiclient.SecurityIdentityBatchConfig
- SecurityIdentityBatchResponse - Class in com.coveo.pushapiclient
-
Used for the responses when pushing batches of Security Identities.
- SecurityIdentityBatchResponse() - Constructor for class com.coveo.pushapiclient.SecurityIdentityBatchResponse
- SecurityIdentityBuilder - Interface in com.coveo.pushapiclient
-
Build a security identity.
- SecurityIdentityDelete - Class in com.coveo.pushapiclient
-
See [Disabling a Single Security Identity](https://docs.coveo.com/en/84)
- SecurityIdentityDelete(IdentityModel) - Constructor for class com.coveo.pushapiclient.SecurityIdentityDelete
- SecurityIdentityDeleteOptions - Class in com.coveo.pushapiclient
-
See [Disabling Old Security Identities](https://docs.coveo.com/en/33)
- SecurityIdentityDeleteOptions(Integer, Long) - Constructor for class com.coveo.pushapiclient.SecurityIdentityDeleteOptions
- SecurityIdentityModel - Class in com.coveo.pushapiclient
-
See [Security Identity Models](https://docs.coveo.com/en/139)
- SecurityIdentityModel(IdentityModel[], IdentityModel, IdentityModel[]) - Constructor for class com.coveo.pushapiclient.SecurityIdentityModel
- SecurityIdentityModelBase - Class in com.coveo.pushapiclient
- SecurityIdentityModelBase(IdentityModel, IdentityModel[]) - Constructor for class com.coveo.pushapiclient.SecurityIdentityModelBase
- SecurityIdentityType - Enum in com.coveo.pushapiclient
- securityProvider - Variable in class com.coveo.pushapiclient.SecurityIdentity
-
The security identity provider through which the security identity is updated.
- setBatchResponse(HttpResponse<String>) - Method in class com.coveo.pushapiclient.SecurityIdentityBatchResponse
- setS3Response(HttpResponse<String>) - Method in class com.coveo.pushapiclient.SecurityIdentityBatchResponse
- SHARED - Enum constant in enum com.coveo.pushapiclient.SourceVisibility
-
Items can be accessed by any user.
- Source - Class in com.coveo.pushapiclient
- Source(String, String) - Constructor for class com.coveo.pushapiclient.Source
- Source(String, String, Environment) - Constructor for class com.coveo.pushapiclient.Source
-
Deprecated.Please now use PlatformUrl to define your Platform environment
- Source(String, String, PlatformUrl) - Constructor for class com.coveo.pushapiclient.Source
- SourceVisibility - Enum in com.coveo.pushapiclient
-
SourceVisibility controls the content security option that should be applied to the items in a source.
- STAGING - Enum constant in enum com.coveo.pushapiclient.Environment
T
- title - Variable in class com.coveo.pushapiclient.Document
-
The title of the document.
- toString() - Method in class com.coveo.pushapiclient.BatchUpdate
- toString() - Method in class com.coveo.pushapiclient.BatchUpdateRecord
- toString() - Method in class com.coveo.pushapiclient.CompressedBinaryData
- toString() - Method in class com.coveo.pushapiclient.GroupSecurityIdentityBuilder
- toString() - Method in class com.coveo.pushapiclient.SecurityIdentityBatchConfig
- toString() - Method in class com.coveo.pushapiclient.SecurityIdentityDelete
- toString() - Method in class com.coveo.pushapiclient.SecurityIdentityDeleteOptions
- toString() - Method in class com.coveo.pushapiclient.UserSecurityIdentityBuilder
- toString() - Method in class com.coveo.pushapiclient.VirtualGroupSecurityIdentityBuilder
- type - Variable in class com.coveo.pushapiclient.IdentityModel
U
- UNCOMPRESSED - Enum constant in enum com.coveo.pushapiclient.CompressionType
- UNKNOWN - Enum constant in enum com.coveo.pushapiclient.SecurityIdentityType
- updateSourceStatus(String, PushAPIStatus) - Method in class com.coveo.pushapiclient.PlatformClient
-
Update the status of a Push source.
- updateSourceStatus(String, PushAPIStatus) - Method in class com.coveo.pushapiclient.Source
-
Update the status of a Push source.
- uploadContentToFileContainer(FileContainer, String) - Method in class com.coveo.pushapiclient.PlatformClient
-
Upload content update into a file container.
- uploadUri - Variable in class com.coveo.pushapiclient.FileContainer
- uri - Variable in class com.coveo.pushapiclient.Document
-
The Uniform Resource Identifier (URI) that uniquely identifies the document in a Coveo index.
- US - Enum constant in enum com.coveo.pushapiclient.Region
- USER - Enum constant in enum com.coveo.pushapiclient.SecurityIdentityType
- UserSecurityIdentityBuilder - Class in com.coveo.pushapiclient
-
Build a security identity of type `USER`.
- UserSecurityIdentityBuilder(String) - Constructor for class com.coveo.pushapiclient.UserSecurityIdentityBuilder
-
Construct a UserSecurityIdentityBuilder for a single identity with an `Email Security Provider`.
- UserSecurityIdentityBuilder(String[]) - Constructor for class com.coveo.pushapiclient.UserSecurityIdentityBuilder
-
Construct a UserSecurityIdentityBuilder for multiple identities with an `Email Security Provider`.
- UserSecurityIdentityBuilder(String[], String) - Constructor for class com.coveo.pushapiclient.UserSecurityIdentityBuilder
- UserSecurityIdentityBuilder(String, String) - Constructor for class com.coveo.pushapiclient.UserSecurityIdentityBuilder
-
Construct a UserSecurityIdentityBuilder for a single identity with the given security provider.
V
- valueOf(String) - Static method in enum com.coveo.pushapiclient.CompressionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.coveo.pushapiclient.Environment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.coveo.pushapiclient.PushAPIStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.coveo.pushapiclient.Region
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.coveo.pushapiclient.SecurityIdentityType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.coveo.pushapiclient.SourceVisibility
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.coveo.pushapiclient.CompressionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.coveo.pushapiclient.Environment
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.coveo.pushapiclient.PushAPIStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.coveo.pushapiclient.Region
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.coveo.pushapiclient.SecurityIdentityType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.coveo.pushapiclient.SourceVisibility
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VIRTUAL_GROUP - Enum constant in enum com.coveo.pushapiclient.SecurityIdentityType
- VirtualGroupSecurityIdentityBuilder - Class in com.coveo.pushapiclient
-
Build a security identity of type `VIRTUAL_GROUP`.
- VirtualGroupSecurityIdentityBuilder(String[], String) - Constructor for class com.coveo.pushapiclient.VirtualGroupSecurityIdentityBuilder
- VirtualGroupSecurityIdentityBuilder(String, String) - Constructor for class com.coveo.pushapiclient.VirtualGroupSecurityIdentityBuilder
-
Construct a VirtualGroupSecurityIdentityBuilder with a single identity.
W
- wellKnowns - Variable in class com.coveo.pushapiclient.SecurityIdentityModelBase
- withAllowAnonymousUsers(Boolean) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set allowAnonymous for permissions on the document.
- withAllowedPermissions(SecurityIdentityBuilder) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set allowed identities on the document.
- withAuthor(String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the author on the document.
- withClickableUri(String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the clickableURI on the document.
- withCompressedBinaryData(CompressedBinaryData) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the base64 encoded, compressed binary data of the document.
- withCompressedBinaryDataFileId(String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the file container file ID for the compressed binary data of the document.
- withData(String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the data of the document.
- withDate(Long) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the date of the document.
- withDate(String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the date of the document.
- withDate(Date) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the date of the document.
- withDate(DateTime) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the date of the document.
- withDeniedPermissions(SecurityIdentityBuilder) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set denied identities on the document.
- withDocumentPermissions(DocumentPermissions[]) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the fully built out DocumentPermissions array.
- withEnvironment(Environment) - Method in class com.coveo.pushapiclient.PlatformUrlBuilder
- withFileExtension(String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the file extension on the document.
- withMetadata(Map<String, Object>) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set metadata on the document.
- withMetadataValue(String, Integer) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Add a single metadata key and value pair on the document.
- withMetadataValue(String, Integer[]) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Add a single metadata key and value pair on the document.
- withMetadataValue(String, String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Add a single metadata key and value pair on the document.
- withMetadataValue(String, String[]) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Add a single metadata key and value pair on the document.
- withModifiedDate(Long) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the modified date of the document.
- withModifiedDate(String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the modified date of the document.
- withModifiedDate(Date) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the modified date of the document.
- withModifiedDate(DateTime) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the modified date of the document.
- withParentID(String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the parentID on the document.
- withPermanentId(String) - Method in class com.coveo.pushapiclient.DocumentBuilder
-
Set the permanentID of the document.
- withRegion(Region) - Method in class com.coveo.pushapiclient.PlatformUrlBuilder
Z
- ZLIB - Enum constant in enum com.coveo.pushapiclient.CompressionType
All Classes and Interfaces|All Packages