com.crowdin.client.translationmemory

Class TranslationMemoryApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.translationmemory.TranslationMemoryApi

public class TranslationMemoryApi
extends CrowdinApi

Field Summary

Fields inherited from class com.crowdin.client.core.CrowdinApi

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

Constructor and Description
TranslationMemoryApi(Credentials credentials)
TranslationMemoryApi(Credentials credentials, ClientConfig clientConfig)

Method Summary

Modifier and Type	Method and Description
ResponseObject<TranslationMemory>	addTm(AddTranslationMemoryRequest request)
ResponseObject<TranslationMemoryExportStatus>	checkTmExportStatus(java.lang.Long tmId, java.lang.String exportId)
ResponseObject<TranslationMemoryImportStatus>	checkTmImportStatus(java.lang.Long tmId, java.lang.String importId)
void	clearTm(java.lang.Long tmId)
ResponseObject<TmSegment>	createTmSegment(java.lang.Long tmId, CreateTmSegmentRequest request)
void	deleteTm(java.lang.Long tmId)
void	deleteTmSegment(java.lang.Long tmId, java.lang.Long segmentId)
ResponseObject<DownloadLink>	downloadTm(java.lang.Long tmId, java.lang.String exportId)
ResponseObject<TranslationMemory>	editTm(java.lang.Long tmId, java.util.List<PatchRequest> request)
ResponseObject<TmSegment>	editTmSegment(java.lang.Long tmId, java.lang.Long segmentId, java.util.List<PatchRequest> request)
ResponseObject<TranslationMemoryExportStatus>	exportTm(java.lang.Long tmId, TranslationMemoryExportRequest request)
ResponseObject<TranslationMemory>	getTm(java.lang.Long tmId)
ResponseObject<TmSegment>	getTmSegment(java.lang.Long tmId, java.lang.Long segmentId)
ResponseObject<TranslationMemoryImportStatus>	importTm(java.lang.Long tmId, TranslationMemoryImportRequest request)
ResponseList<TranslationMemory>	listTms(java.lang.Long groupId, java.lang.Integer limit, java.lang.Integer offset, java.lang.Integer userId)
ResponseList<TranslationMemory>	listTms(java.lang.Long groupId, java.lang.Integer limit, java.lang.Integer offset, java.lang.Integer userId, java.util.List<OrderByField> orderBy)
ResponseList<TmSegment>	listTmSegments(java.lang.Long tmId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<TmSegment>	listTmSegments(java.lang.Long tmId, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<SearchConcordance>	searchConcordance(java.lang.Long projectId, SearchConcordanceRequest request)

Methods inherited from class com.crowdin.client.core.CrowdinApi

graphql, graphql

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslationMemoryApi

public TranslationMemoryApi(Credentials credentials)

TranslationMemoryApi

public TranslationMemoryApi(Credentials credentials,
                            ClientConfig clientConfig)

Method Detail

searchConcordance

public ResponseList<SearchConcordance> searchConcordance(java.lang.Long projectId,
                                                         SearchConcordanceRequest request)

Parameters:

projectId - project identifier

request - request object

Returns:

list of search results

See Also:

• API Documentation
• Enterprise API Documentation

listTms

public ResponseList<TranslationMemory> listTms(java.lang.Long groupId,
                                               java.lang.Integer limit,
                                               java.lang.Integer offset,
                                               java.lang.Integer userId)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

groupId - group identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

userId - filter by user identifier

Returns:

list of translation memories

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTms

public ResponseList<TranslationMemory> listTms(java.lang.Long groupId,
                                               java.lang.Integer limit,
                                               java.lang.Integer offset,
                                               java.lang.Integer userId,
                                               java.util.List<OrderByField> orderBy)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

groupId - group identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

userId - filter by user identifier

orderBy - list of OrderByField

Returns:

list of translation memories

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addTm

public ResponseObject<TranslationMemory> addTm(AddTranslationMemoryRequest request)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

request - request object

Returns:

newly created translation memory

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getTm

public ResponseObject<TranslationMemory> getTm(java.lang.Long tmId)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

tmId - translation memory identifier

Returns:

translation memory

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteTm

public void deleteTm(java.lang.Long tmId)
              throws HttpException,
                     HttpBadRequestException

Parameters:

tmId - translation memory identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editTm

public ResponseObject<TranslationMemory> editTm(java.lang.Long tmId,
                                                java.util.List<PatchRequest> request)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

tmId - translation memory identifier

request - request object

Returns:

updated translation memory

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

clearTm

public void clearTm(java.lang.Long tmId)
             throws HttpException,
                    HttpBadRequestException

Parameters:

tmId - translation memory identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

exportTm

public ResponseObject<TranslationMemoryExportStatus> exportTm(java.lang.Long tmId,
                                                              TranslationMemoryExportRequest request)
                                                       throws HttpException,
                                                              HttpBadRequestException

Parameters:

tmId - translation memory identifier

request - request object

Returns:

export status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

checkTmExportStatus

public ResponseObject<TranslationMemoryExportStatus> checkTmExportStatus(java.lang.Long tmId,
                                                                         java.lang.String exportId)
                                                                  throws HttpException,
                                                                         HttpBadRequestException

Parameters:

tmId - translation memory identifier

exportId - export identifier

Returns:

export status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

downloadTm

public ResponseObject<DownloadLink> downloadTm(java.lang.Long tmId,
                                               java.lang.String exportId)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

tmId - translation memory identifier

exportId - export identifier

Returns:

download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

importTm

public ResponseObject<TranslationMemoryImportStatus> importTm(java.lang.Long tmId,
                                                              TranslationMemoryImportRequest request)
                                                       throws HttpException,
                                                              HttpBadRequestException

Parameters:

tmId - translation memory identifier

request - request object

Returns:

import status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

checkTmImportStatus

public ResponseObject<TranslationMemoryImportStatus> checkTmImportStatus(java.lang.Long tmId,
                                                                         java.lang.String importId)
                                                                  throws HttpException,
                                                                         HttpBadRequestException

Parameters:

tmId - translation memory identifier

importId - import identifier

Returns:

import status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTmSegments

public ResponseList<TmSegment> listTmSegments(java.lang.Long tmId,
                                              java.lang.Integer limit,
                                              java.lang.Integer offset)
                                       throws HttpException,
                                              HttpBadRequestException

Parameters:

tmId - translation memory identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of translation memory segments

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTmSegments

public ResponseList<TmSegment> listTmSegments(java.lang.Long tmId,
                                              java.lang.Integer limit,
                                              java.lang.Integer offset,
                                              java.util.List<OrderByField> orderBy)
                                       throws HttpException,
                                              HttpBadRequestException

Parameters:

tmId - translation memory identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of translation memory segments

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

createTmSegment

public ResponseObject<TmSegment> createTmSegment(java.lang.Long tmId,
                                                 CreateTmSegmentRequest request)
                                          throws HttpException,
                                                 HttpBadRequestException

Parameters:

tmId - translation memory identifier

request - request object

Returns:

newly created translation memory segment

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getTmSegment

public ResponseObject<TmSegment> getTmSegment(java.lang.Long tmId,
                                              java.lang.Long segmentId)
                                       throws HttpException,
                                              HttpBadRequestException

Parameters:

tmId - translation memory identifier

segmentId - segment identifier

Returns:

translation memory segment

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteTmSegment

public void deleteTmSegment(java.lang.Long tmId,
                            java.lang.Long segmentId)
                     throws HttpException,
                            HttpBadRequestException

Parameters:

tmId - translation memory identifier

segmentId - segment identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editTmSegment

public ResponseObject<TmSegment> editTmSegment(java.lang.Long tmId,
                                               java.lang.Long segmentId,
                                               java.util.List<PatchRequest> request)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

tmId - translation memory identifier

segmentId - segment identifier

request - request object

Returns:

updated translation memory segment

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation