PushDocumentsRequestModel is the request parameter type for Client.pushDocuments(). Build an instance of this class to specify the HTTP headers and document list before calling pushDocuments().
Thread safety: Thread-safe. Instances can be shared across threads and reused across multiple calls.
Constructor
PushDocumentsRequestModel()Methods
setHeaders
Sets the HTTP request headers.
PushDocumentsRequestModel setHeaders(java.util.Map<String, String> headers)| Parameter | Type | Description |
|---|---|---|
headers | Map<String, String> | The information about request headers. |
Returns the current PushDocumentsRequestModel instance to support method chaining.
getHeaders
Returns the headers set on this request.
java.util.Map<String, String> getHeaders()Returns: java.util.Map<String, String> — the headers parameter value.
setBody
Sets the list of documents to push.
PushDocumentsRequestModel setBody(java.util.List<java.util.Map<String, ?>> body)| Parameter | Type | Description |
|---|---|---|
body | List<Map<String, ?>> | The information about the request body. |
Returns the current PushDocumentsRequestModel instance to support method chaining.
getBody
Returns the document list set on this request.
java.util.List<java.util.Map<String, ?>> getBody()Returns: java.util.List<java.util.Map<String, ?>> — the body parameter value.
What's next
Client class — see
pushDocuments()for the full method signature and response handling.