BatchService 0.23.1 API

All Implemented Interfaces:


public interface BatchService

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract Batch`	`create(BatchCreateParams params, RequestOptions requestOptions)`	Creates and executes a batch from an uploaded file of requests
`abstract Batch`	`create(BatchCreateParams params)`	Creates and executes a batch from an uploaded file of requests
`abstract Batch`	`retrieve(BatchRetrieveParams params, RequestOptions requestOptions)`	Retrieves a batch.
`abstract Batch`	`retrieve(BatchRetrieveParams params)`	Retrieves a batch.
`abstract BatchListPage`	`list(BatchListParams params, RequestOptions requestOptions)`	List your organization's batches.
`abstract BatchListPage`	`list(BatchListParams params)`	List your organization's batches.
`abstract Batch`	`cancel(BatchCancelParams params, RequestOptions requestOptions)`	Cancels an in-progress batch.
`abstract Batch`	`cancel(BatchCancelParams params)`	Cancels an in-progress batch.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - create
```
 abstract Batch create(BatchCreateParams params, RequestOptions requestOptions)
```
    Creates and executes a batch from an uploaded file of requests
  - create
```
 abstract Batch create(BatchCreateParams params)
```
    Creates and executes a batch from an uploaded file of requests
  - retrieve
```
 abstract Batch retrieve(BatchRetrieveParams params, RequestOptions requestOptions)
```
    Retrieves a batch.
  - retrieve
```
 abstract Batch retrieve(BatchRetrieveParams params)
```
    Retrieves a batch.
  - list
```
 abstract BatchListPage list(BatchListParams params, RequestOptions requestOptions)
```
    List your organization's batches.
  - list
```
 abstract BatchListPage list(BatchListParams params)
```
    List your organization's batches.
  - cancel
```
 abstract Batch cancel(BatchCancelParams params, RequestOptions requestOptions)
```
    Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file.
  - cancel
```
 abstract Batch cancel(BatchCancelParams params)
```
    Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file.