Response Body Schema
+ * + *
+ * {@code
+ * {
+ * path: String (Optional)
+ * sourcePath: String (Required)
+ * createdDateTimeUtc: OffsetDateTime (Required)
+ * lastActionDateTimeUtc: OffsetDateTime (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Cancelled/Cancelling/ValidationFailed) (Required)
+ * to: String (Required)
+ * error (Optional): {
+ * code: String(InvalidRequest/InvalidArgument/InternalServerError/ServiceUnavailable/ResourceNotFound/Unauthorized/RequestRateTooHigh) (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * innerError (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * innerError (Optional): (recursive schema, see innerError above)
+ * }
+ * }
+ * progress: double (Required)
+ * id: String (Required)
+ * characterCharged: Integer (Optional)
+ * }
+ * }
+ *
+ *
+ * @param translationId Format - uuid. The batch id.
+ * @param documentId Format - uuid. The document id.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return document Status Response along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * createdDateTimeUtc: OffsetDateTime (Required)
+ * lastActionDateTimeUtc: OffsetDateTime (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Cancelled/Cancelling/ValidationFailed) (Required)
+ * error (Optional): {
+ * code: String(InvalidRequest/InvalidArgument/InternalServerError/ServiceUnavailable/ResourceNotFound/Unauthorized/RequestRateTooHigh) (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * innerError (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * innerError (Optional): (recursive schema, see innerError above)
+ * }
+ * }
+ * summary (Required): {
+ * total: int (Required)
+ * failed: int (Required)
+ * success: int (Required)
+ * inProgress: int (Required)
+ * notYetStarted: int (Required)
+ * cancelled: int (Required)
+ * totalCharacterCharged: long (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param translationId Format - uuid. The operation id.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return translation job status response along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * createdDateTimeUtc: OffsetDateTime (Required)
+ * lastActionDateTimeUtc: OffsetDateTime (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Cancelled/Cancelling/ValidationFailed) (Required)
+ * error (Optional): {
+ * code: String(InvalidRequest/InvalidArgument/InternalServerError/ServiceUnavailable/ResourceNotFound/Unauthorized/RequestRateTooHigh) (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * innerError (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * innerError (Optional): (recursive schema, see innerError above)
+ * }
+ * }
+ * summary (Required): {
+ * total: int (Required)
+ * failed: int (Required)
+ * success: int (Required)
+ * inProgress: int (Required)
+ * notYetStarted: int (Required)
+ * cancelled: int (Required)
+ * totalCharacterCharged: long (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param translationId Format - uuid. The operation-id.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return translation job status response along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| type | String | No | the type of format like document or glossary . Allowed values: + * "document", "glossary". |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * format: String (Required)
+ * fileExtensions (Required): [
+ * String (Required)
+ * ]
+ * contentTypes (Required): [
+ * String (Required)
+ * ]
+ * defaultVersion: String (Optional)
+ * versions (Optional): [
+ * String (Optional)
+ * ]
+ * type: String(document/glossary) (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return list of supported file formats along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ MonoQuery Parameters
- *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | top indicates the total number of records the user wants to be - * returned across - * all pages. - * - * Clients MAY use top and skip query parameters to - * specify a number of results to return and an offset into the collection. - * When - * both top and skip are given by a client, the server SHOULD first apply skip - * and then top on the collection. - * - * Note: If the server can't honor - * top and/or skip, the server MUST return an error to the client informing - * about it instead of just ignoring the query options. |
| skip | Integer | No | skip indicates the number of records to skip from the list of - * records held by - * the server based on the sorting method specified. By default, we sort by - * descending start time. - * - * Clients MAY use top and skip query - * parameters to specify a number of results to return and an offset into the - * collection. - * When both top and skip are given by a client, the server SHOULD - * first apply skip and then top on the collection. - * - * Note: If the - * server can't honor top and/or skip, the server MUST return an error to the - * client informing about it instead of just ignoring the query options. |
| maxpagesize | Integer | No | maxpagesize is the maximum items returned in a page. If - * more items are - * requested via top (or top is not specified and there are more items to be - * returned), @nextLink will contain the link to the next page. - * - * Clients MAY request server-driven paging with a specific page size by - * specifying a maxpagesize preference. The server SHOULD honor this preference - * if the specified page size is smaller than the server's default page size. |
| ids | List<String> | No | Ids to use in filtering. In the form of "," separated - * string. |
| statuses | List<String> | No | Statuses to use in filtering. In the form of "," - * separated string. |
| createdDateTimeUtcStart | OffsetDateTime | No | the start datetime to get items - * after |
| createdDateTimeUtcEnd | OffsetDateTime | No | the end datetime to get items - * before |
| orderby | List<String> | No | the sorting query for the collection (ex: - * 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc'). In the form of "," separated string. |
Response Body Schema
- * - *
- * {@code
- * {
- * id: String (Required)
- * createdDateTimeUtc: OffsetDateTime (Required)
- * lastActionDateTimeUtc: OffsetDateTime (Required)
- * status: String(NotStarted/Running/Succeeded/Failed/Cancelled/Cancelling/ValidationFailed) (Required)
- * error (Optional): {
- * code: String(InvalidRequest/InvalidArgument/InternalServerError/ServiceUnavailable/ResourceNotFound/Unauthorized/RequestRateTooHigh) (Required)
- * message: String (Required)
- * target: String (Optional)
- * innerError (Optional): {
- * code: String (Required)
- * message: String (Required)
- * target: String (Optional)
- * innerError (Optional): (recursive schema, see innerError above)
- * }
- * }
- * summary (Required): {
- * total: int (Required)
- * failed: int (Required)
- * success: int (Required)
- * inProgress: int (Required)
- * notYetStarted: int (Required)
- * cancelled: int (Required)
- * totalCharacterCharged: long (Required)
- * }
- * }
- * }
- *
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return translation job Status Response as paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema
- * - *
- * {@code
- * {
- * path: String (Optional)
- * sourcePath: String (Required)
- * createdDateTimeUtc: OffsetDateTime (Required)
- * lastActionDateTimeUtc: OffsetDateTime (Required)
- * status: String(NotStarted/Running/Succeeded/Failed/Cancelled/Cancelling/ValidationFailed) (Required)
- * to: String (Required)
- * error (Optional): {
- * code: String(InvalidRequest/InvalidArgument/InternalServerError/ServiceUnavailable/ResourceNotFound/Unauthorized/RequestRateTooHigh) (Required)
- * message: String (Required)
- * target: String (Optional)
- * innerError (Optional): {
- * code: String (Required)
- * message: String (Required)
- * target: String (Optional)
- * innerError (Optional): (recursive schema, see innerError above)
- * }
- * }
- * progress: double (Required)
- * id: String (Required)
- * characterCharged: Integer (Optional)
- * }
- * }
- *
- *
- * @param id Format - uuid. The batch id.
- * @param documentId Format - uuid. The document id.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return document Status Response along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema
- * - *
- * {@code
- * {
- * id: String (Required)
- * createdDateTimeUtc: OffsetDateTime (Required)
- * lastActionDateTimeUtc: OffsetDateTime (Required)
- * status: String(NotStarted/Running/Succeeded/Failed/Cancelled/Cancelling/ValidationFailed) (Required)
- * error (Optional): {
- * code: String(InvalidRequest/InvalidArgument/InternalServerError/ServiceUnavailable/ResourceNotFound/Unauthorized/RequestRateTooHigh) (Required)
- * message: String (Required)
- * target: String (Optional)
- * innerError (Optional): {
- * code: String (Required)
- * message: String (Required)
- * target: String (Optional)
- * innerError (Optional): (recursive schema, see innerError above)
- * }
- * }
- * summary (Required): {
- * total: int (Required)
- * failed: int (Required)
- * success: int (Required)
- * inProgress: int (Required)
- * notYetStarted: int (Required)
- * cancelled: int (Required)
- * totalCharacterCharged: long (Required)
- * }
- * }
- * }
- *
+ * Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | top indicates the total number of records the user wants to be
+ * returned across
+ * all pages.
*
- * @param id Format - uuid. The operation id.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return translation job status response along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public Mono |
| skip | Integer | No | skip indicates the number of records to skip from the list of + * records held by + * the server based on the sorting method specified. By default, we sort by + * descending start time. + * + * Clients MAY use top and skip query + * parameters to specify a number of results to return and an offset into the + * collection. + * When both top and skip are given by a client, the server SHOULD + * first apply skip and then top on the collection. + * + * Note: If the + * server can't honor top and/or skip, the server MUST return an error to the + * client informing about it instead of just ignoring the query options. |
| maxpagesize | Integer | No | maxpagesize is the maximum items returned in a page. If + * more items are + * requested via top (or top is not specified and there are more items to be + * returned), @nextLink will contain the link to the next page. + * + * Clients MAY request server-driven paging with a specific page size by + * specifying a maxpagesize preference. The server SHOULD honor this preference + * if the specified page size is smaller than the server's default page size. |
| ids | List<String> | No | Ids to use in filtering. In the form of "," separated + * string. |
| statuses | List<String> | No | Statuses to use in filtering. In the form of "," + * separated string. |
| createdDateTimeUtcStart | OffsetDateTime | No | the start datetime to get items + * after |
| createdDateTimeUtcEnd | OffsetDateTime | No | the end datetime to get items + * before |
| orderby | List<String> | No | the sorting query for the collection (ex: + * 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc'). In the form of "," separated string. |
Response Body Schema
* *