public class EntriesClientImpl extends ApiClient implements EntriesClient
baseUrl, httpClient, objectMapper| Constructor and Description |
|---|
EntriesClientImpl(String baseUrl,
kong.unirest.UnirestInstance httpClient) |
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<ODataValueOfIListOfWEntryLinkInfo> |
assignEntryLinks(String repoId,
Integer entryId,
List<PutLinksRequest> requestBody)
- Assign links to an entry.
|
CompletableFuture<ODataValueOfIListOfFieldValue> |
assignFieldValues(String repoId,
Integer entryId,
Map<String,FieldToUpdate> requestBody,
String culture)
- Update the field values assigned to an entry.
|
CompletableFuture<ODataValueOfIListOfWTagInfo> |
assignTags(String repoId,
Integer entryId,
PutTagRequest requestBody)
- Assign tags to an entry.
|
CompletableFuture<AcceptedOperation> |
copyEntryAsync(String repoId,
Integer entryId,
CopyAsyncRequest requestBody,
Boolean autoRename,
String culture)
- Copy a new child entry in the designated folder async, and potentially return an operationToken.
|
CompletableFuture<Entry> |
createOrCopyEntry(String repoId,
Integer entryId,
PostEntryChildrenRequest requestBody,
Boolean autoRename,
String culture)
- Create/copy a new child entry in the designated folder.
|
CompletableFuture<Entry> |
deleteAssignedTemplate(String repoId,
Integer entryId)
- Remove the currently assigned template from the specified entry.
|
CompletableFuture<ODataValueOfBoolean> |
deleteDocument(String repoId,
Integer entryId)
- Delete the edoc associated with the provided entry ID.
|
CompletableFuture<AcceptedOperation> |
deleteEntryInfo(String repoId,
Integer entryId,
DeleteEntryWithAuditReason requestBody)
- Begins a task to delete an entry, and returns an operationToken.
|
CompletableFuture<ODataValueOfBoolean> |
deletePages(String repoId,
Integer entryId,
String pageRange)
- Delete the pages associated with the provided entry ID.
|
CompletableFuture<Void> |
exportDocument(String repoId,
Integer entryId,
String range,
Consumer<InputStream> inputStreamConsumer)
- Returns an entry's edoc resource in a stream format.
|
CompletableFuture<Void> |
exportDocumentWithAuditReason(String repoId,
Integer entryId,
GetEdocWithAuditReasonRequest requestBody,
String range,
Consumer<InputStream> inputStreamConsumer)
- Returns an entry's edoc resource in a stream format while including an audit reason.
|
CompletableFuture<Map<String,String>> |
getDocumentContentType(String repoId,
Integer entryId)
- Returns information about the edoc content of an entry, without downloading the edoc in its entirety.
|
CompletableFuture<Map<String,String[]>> |
getDynamicFieldValues(String repoId,
Integer entryId,
GetDynamicFieldLogicValueRequest requestBody)
- Returns dynamic field logic values with the current values of the fields in the template.
|
CompletableFuture<Entry> |
getEntry(String repoId,
Integer entryId,
String select)
- Returns a single entry object.
|
CompletableFuture<FindEntryResult> |
getEntryByPath(String repoId,
String fullPath,
Boolean fallbackToClosestAncestor)
- Returns a single entry object using the entry path.
|
CompletableFuture<ODataValueContextOfIListOfEntry> |
getEntryListing(String repoId,
Integer entryId,
Boolean groupByEntryType,
String[] fields,
Boolean formatFields,
String prefer,
String culture,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
- Returns the children entries of a folder in the repository.
|
CompletableFuture<Void> |
getEntryListingForEach(Function<CompletableFuture<ODataValueContextOfIListOfEntry>,CompletableFuture<Boolean>> callback,
Integer maxPageSize,
String repoId,
Integer entryId,
Boolean groupByEntryType,
String[] fields,
Boolean formatFields,
String prefer,
String culture,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
Provides the functionality to iteratively (i.e.
|
CompletableFuture<ODataValueContextOfIListOfEntry> |
getEntryListingNextLink(String nextLink,
Integer maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
CompletableFuture<ODataValueContextOfIListOfFieldValue> |
getFieldValues(String repoId,
Integer entryId,
String prefer,
Boolean formatValue,
String culture,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
- Returns the fields assigned to an entry.
|
CompletableFuture<Void> |
getFieldValuesForEach(Function<CompletableFuture<ODataValueContextOfIListOfFieldValue>,CompletableFuture<Boolean>> callback,
Integer maxPageSize,
String repoId,
Integer entryId,
String prefer,
Boolean formatValue,
String culture,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
Provides the functionality to iteratively (i.e.
|
CompletableFuture<ODataValueContextOfIListOfFieldValue> |
getFieldValuesNextLink(String nextLink,
Integer maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo> |
getLinkValuesFromEntry(String repoId,
Integer entryId,
String prefer,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
- Returns the links assigned to an entry.
|
CompletableFuture<Void> |
getLinkValuesFromEntryForEach(Function<CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo>,CompletableFuture<Boolean>> callback,
Integer maxPageSize,
String repoId,
Integer entryId,
String prefer,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
Provides the functionality to iteratively (i.e.
|
CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo> |
getLinkValuesFromEntryNextLink(String nextLink,
Integer maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
CompletableFuture<ODataValueContextOfIListOfWTagInfo> |
getTagsAssignedToEntry(String repoId,
Integer entryId,
String prefer,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
- Returns the tags assigned to an entry.
|
CompletableFuture<Void> |
getTagsAssignedToEntryForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTagInfo>,CompletableFuture<Boolean>> callback,
Integer maxPageSize,
String repoId,
Integer entryId,
String prefer,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
Provides the functionality to iteratively (i.e.
|
CompletableFuture<ODataValueContextOfIListOfWTagInfo> |
getTagsAssignedToEntryNextLink(String nextLink,
Integer maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
CompletableFuture<CreateEntryResult> |
importDocument(String repoId,
Integer parentEntryId,
String fileName,
Boolean autoRename,
String culture,
InputStream inputStream,
PostEntryWithEdocMetadataRequest requestBody)
- Creates a new document in the specified folder with file (no more than 100 MB).
|
CompletableFuture<Entry> |
moveOrRenameEntry(String repoId,
Integer entryId,
PatchEntryRequest requestBody,
Boolean autoRename,
String culture)
- Moves and/or renames an entry.
|
CompletableFuture<Entry> |
writeTemplateValueToEntry(String repoId,
Integer entryId,
PutTemplateRequest requestBody,
String culture)
- Assign a template to an entry.
|
decideErrorMessage, deserializeToProblemDetails, getHeadersMap, getNonNullParameters, mergeMaxSizeIntoPrefer, toJsonpublic EntriesClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient)
public CompletableFuture<ODataValueContextOfIListOfFieldValue> getFieldValues(String repoId, Integer entryId, String prefer, Boolean formatValue, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)
EntriesClientgetFieldValues in interface EntriesClientrepoId - The requested repository ID.entryId - The requested entry ID.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.formatValue - An optional query parameter used to indicate if the field values should be formatted.
The default value is false.culture - An optional query parameter used to indicate the locale that should be used for formatting.
The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
culture will not be used for formatting.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<ODataValueContextOfIListOfFieldValue> getFieldValuesNextLink(String nextLink, Integer maxPageSize)
EntriesClientgetFieldValuesNextLink in interface EntriesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.public CompletableFuture<Void> getFieldValuesForEach(Function<CompletableFuture<ODataValueContextOfIListOfFieldValue>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Integer entryId, String prefer, Boolean formatValue, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)
EntriesClientgetFieldValuesForEach in interface EntriesClientcallback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.repoId - The requested repository ID.entryId - The requested entry ID.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.formatValue - An optional query parameter used to indicate if the field values should be formatted.
The default value is false.culture - An optional query parameter used to indicate the locale that should be used for formatting.
The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
culture will not be used for formatting.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<ODataValueOfIListOfFieldValue> assignFieldValues(String repoId, Integer entryId, Map<String,FieldToUpdate> requestBody, String culture)
EntriesClientassignFieldValues in interface EntriesClientrepoId - The requested repository ID.entryId - The entry ID of the entry that will have its fields updated.culture - An optional query parameter used to indicate the locale that should be used.
The value should be a standard language tag. This may be used when setting field values with tokens.public CompletableFuture<CreateEntryResult> importDocument(String repoId, Integer parentEntryId, String fileName, Boolean autoRename, String culture, InputStream inputStream, PostEntryWithEdocMetadataRequest requestBody)
EntriesClientimportDocument in interface EntriesClientrepoId - The requested repository ID.parentEntryId - The entry ID of the folder that the document will be created in.fileName - The created document's file name.autoRename - An optional query parameter used to indicate if the new document should be automatically
renamed if an entry already exists with the given name in the folder. The default value is false.culture - An optional query parameter used to indicate the locale that should be used.
The value should be a standard language tag. This may be used when setting field values with tokens.inputStream - An InputStream object to read the raw bytes for the file to be uploaded.requestBody - A value of type PostEntryWithEdocMetadataRequest.public CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo> getLinkValuesFromEntry(String repoId, Integer entryId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)
EntriesClientgetLinkValuesFromEntry in interface EntriesClientrepoId - The requested repository ID.entryId - The requested entry ID.prefer - An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo> getLinkValuesFromEntryNextLink(String nextLink, Integer maxPageSize)
EntriesClientgetLinkValuesFromEntryNextLink in interface EntriesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.public CompletableFuture<Void> getLinkValuesFromEntryForEach(Function<CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Integer entryId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)
EntriesClientgetLinkValuesFromEntryForEach in interface EntriesClientcallback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.repoId - The requested repository ID.entryId - The requested entry ID.prefer - An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<ODataValueOfIListOfWEntryLinkInfo> assignEntryLinks(String repoId, Integer entryId, List<PutLinksRequest> requestBody)
EntriesClientassignEntryLinks in interface EntriesClientrepoId - The request repository ID.entryId - The requested entry ID.requestBody - A value of type List<PutLinksRequest>.public CompletableFuture<Entry> writeTemplateValueToEntry(String repoId, Integer entryId, PutTemplateRequest requestBody, String culture)
EntriesClientwriteTemplateValueToEntry in interface EntriesClientrepoId - The requested repository ID.entryId - The ID of entry that will have its template updated.requestBody - The template and template fields that will be assigned to the entry.culture - An optional query parameter used to indicate the locale that should be used.
The value should be a standard language tag. This may be used when setting field values with tokens.public CompletableFuture<Entry> deleteAssignedTemplate(String repoId, Integer entryId)
EntriesClientdeleteAssignedTemplate in interface EntriesClientrepoId - The requested repository ID.entryId - The ID of the entry that will have its template removed.public CompletableFuture<Map<String,String[]>> getDynamicFieldValues(String repoId, Integer entryId, GetDynamicFieldLogicValueRequest requestBody)
EntriesClientgetDynamicFieldValues in interface EntriesClientrepoId - The requested repository ID.entryId - The requested entry ID.requestBody - A value of type GetDynamicFieldLogicValueRequest.public CompletableFuture<FindEntryResult> getEntryByPath(String repoId, String fullPath, Boolean fallbackToClosestAncestor)
EntriesClientgetEntryByPath in interface EntriesClientrepoId - The requested repository ID.fullPath - The requested entry path.fallbackToClosestAncestor - An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false.public CompletableFuture<AcceptedOperation> copyEntryAsync(String repoId, Integer entryId, CopyAsyncRequest requestBody, Boolean autoRename, String culture)
EntriesClientcopyEntryAsync in interface EntriesClientrepoId - The requested repository ID.entryId - The folder ID that the entry will be created in.requestBody - Copy entry request.autoRename - An optional query parameter used to indicate if the new entry should be automatically
renamed if an entry already exists with the given name in the folder. The default value is false.culture - An optional query parameter used to indicate the locale that should be used.
The value should be a standard language tag.public CompletableFuture<Entry> getEntry(String repoId, Integer entryId, String select)
EntriesClientgetEntry in interface EntriesClientrepoId - The requested repository ID.entryId - The requested entry ID.select - Limits the properties returned in the result.public CompletableFuture<Entry> moveOrRenameEntry(String repoId, Integer entryId, PatchEntryRequest requestBody, Boolean autoRename, String culture)
EntriesClientmoveOrRenameEntry in interface EntriesClientrepoId - The requested repository ID.entryId - The requested entry ID.requestBody - The request containing the folder ID that the entry will be moved to and the new name
the entry will be renamed to.autoRename - An optional query parameter used to indicate if the entry should be automatically
renamed if another entry already exists with the same name in the folder. The default value is false.culture - An optional query parameter used to indicate the locale that should be used.
The value should be a standard language tag.public CompletableFuture<AcceptedOperation> deleteEntryInfo(String repoId, Integer entryId, DeleteEntryWithAuditReason requestBody)
EntriesClientdeleteEntryInfo in interface EntriesClientrepoId - The requested repository ID.entryId - The requested entry ID.requestBody - The submitted audit reason.public CompletableFuture<Void> exportDocumentWithAuditReason(String repoId, Integer entryId, GetEdocWithAuditReasonRequest requestBody, String range, Consumer<InputStream> inputStreamConsumer)
EntriesClientexportDocumentWithAuditReason in interface EntriesClientrepoId - The requested repository ID.entryId - The requested document ID.requestBody - A value of type GetEdocWithAuditReasonRequest.range - An optional header used to retrieve partial content of the edoc. Only supports single
range with byte unit.inputStreamConsumer - A Consumer<InputStream> object that the is provided with the response's inputStream to consume it, if the request has been successful.public CompletableFuture<Void> exportDocument(String repoId, Integer entryId, String range, Consumer<InputStream> inputStreamConsumer)
EntriesClientexportDocument in interface EntriesClientrepoId - The requested repository ID.entryId - The requested document ID.range - An optional header used to retrieve partial content of the edoc. Only supports single
range with byte unit.inputStreamConsumer - A Consumer<InputStream> object that the is provided with the response's inputStream to consume it, if the request has been successful.public CompletableFuture<ODataValueOfBoolean> deleteDocument(String repoId, Integer entryId)
EntriesClientdeleteDocument in interface EntriesClientrepoId - The requested repository ID.entryId - The requested document ID.public CompletableFuture<Map<String,String>> getDocumentContentType(String repoId, Integer entryId)
EntriesClientgetDocumentContentType in interface EntriesClientrepoId - The requested repository ID.entryId - The requested document ID.public CompletableFuture<ODataValueOfBoolean> deletePages(String repoId, Integer entryId, String pageRange)
EntriesClientdeletePages in interface EntriesClientrepoId - The requested repository ID.entryId - The requested document ID.pageRange - The pages to be deleted.public CompletableFuture<ODataValueContextOfIListOfEntry> getEntryListing(String repoId, Integer entryId, Boolean groupByEntryType, String[] fields, Boolean formatFields, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)
EntriesClientgetEntryListing in interface EntriesClientrepoId - The requested repository ID.entryId - The folder ID.groupByEntryType - An optional query parameter used to indicate if the result should be grouped by entry type or not.fields - Optional array of field names. Field values corresponding to the given field names will be returned for each entry.formatFields - Boolean for if field values should be formatted. Only applicable if Fields are specified.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.culture - An optional query parameter used to indicate the locale that should be used for formatting.
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
culture will not be used for formatting.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<ODataValueContextOfIListOfEntry> getEntryListingNextLink(String nextLink, Integer maxPageSize)
EntriesClientgetEntryListingNextLink in interface EntriesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.public CompletableFuture<Void> getEntryListingForEach(Function<CompletableFuture<ODataValueContextOfIListOfEntry>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Integer entryId, Boolean groupByEntryType, String[] fields, Boolean formatFields, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)
EntriesClientgetEntryListingForEach in interface EntriesClientcallback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.repoId - The requested repository ID.entryId - The folder ID.groupByEntryType - An optional query parameter used to indicate if the result should be grouped by entry type or not.fields - Optional array of field names. Field values corresponding to the given field names will be returned for each entry.formatFields - Boolean for if field values should be formatted. Only applicable if Fields are specified.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.culture - An optional query parameter used to indicate the locale that should be used for formatting.
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
culture will not be used for formatting.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<Entry> createOrCopyEntry(String repoId, Integer entryId, PostEntryChildrenRequest requestBody, Boolean autoRename, String culture)
EntriesClientcreateOrCopyEntry in interface EntriesClientrepoId - The requested repository ID.entryId - The folder ID that the entry will be created in.requestBody - The entry to create.autoRename - An optional query parameter used to indicate if the new entry should be automatically
renamed if an entry already exists with the given name in the folder. The default value is false.culture - An optional query parameter used to indicate the locale that should be used.
The value should be a standard language tag.public CompletableFuture<ODataValueContextOfIListOfWTagInfo> getTagsAssignedToEntry(String repoId, Integer entryId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)
EntriesClientgetTagsAssignedToEntry in interface EntriesClientrepoId - The requested repository ID.entryId - The requested entry ID.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<ODataValueContextOfIListOfWTagInfo> getTagsAssignedToEntryNextLink(String nextLink, Integer maxPageSize)
EntriesClientgetTagsAssignedToEntryNextLink in interface EntriesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.public CompletableFuture<Void> getTagsAssignedToEntryForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTagInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Integer entryId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)
EntriesClientgetTagsAssignedToEntryForEach in interface EntriesClientcallback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.repoId - The requested repository ID.entryId - The requested entry ID.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<ODataValueOfIListOfWTagInfo> assignTags(String repoId, Integer entryId, PutTagRequest requestBody)
EntriesClientassignTags in interface EntriesClientrepoId - The requested repository ID.entryId - The requested entry ID.requestBody - The tags to add.Copyright © 2022. All rights reserved.