WeDeploy (api 1.0.0 API)

java.lang.Object
- com.wedeploy.api.WeDeploy

public class WeDeploy
extends java.lang.Object

Java client.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Auth`	`auth`
`protected java.util.List<Cookie>`	`cookies`
`protected Transport`	`currentTransport`
`protected MultiMap<java.lang.Object>`	`forms`
`protected MultiMap<java.lang.String>`	`headers`
`static java.lang.String`	`MASTER_TOKEN`
`static java.lang.String`	`METHOD_DELETE`
`static java.lang.String`	`METHOD_GET`
`static java.lang.String`	`METHOD_HEAD`
`static java.lang.String`	`METHOD_OPTION`
`static java.lang.String`	`METHOD_PATCH`
`static java.lang.String`	`METHOD_POST`
`static java.lang.String`	`METHOD_PUT`
`protected MultiMap<java.lang.String>`	`params`
`protected Query.Builder`	`query`
`protected java.lang.String`	`url`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`WeDeploy(java.lang.String url)` Main constructor.
`protected`	`WeDeploy(java.lang.String baseUrl, java.lang.String url)` Continuations constructor, used from existing instance, therefore no need to configure the client.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WeDeploy`	`aggregate(Aggregation aggregation)` See `Query.Builder`
`WeDeploy`	`aggregate(java.lang.String name, java.lang.String field, java.lang.String operator)` See `Query.Builder`
`WeDeploy`	`auth(Auth auth)` Authenticates with an auth instance.
`WeDeploy`	`auth(java.lang.String token)` Authenticates with token.
`WeDeploy`	`auth(java.lang.String username, java.lang.String password)`
`WeDeploy`	`contentType(ContentType contentType)` Sets the content type header of the request.
`WeDeploy`	`cookie(Cookie cookie)`
`WeDeploy`	`count()` See `Query.Builder`
`Response`	`delete()` Executes DELETE request.
`Response`	`delete(java.lang.Object body)` Executes DELETE request.
`Response`	`delete(java.lang.String body)` Executes DELETE request.
`java.util.concurrent.CompletableFuture<Response>`	`deleteAsync()` Executes DELETE request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`deleteAsync(java.lang.Object body)` Serializes object and executes DELETE request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`deleteAsync(java.lang.String body)` Executes DELETE request asynchronously.
`WeDeploy`	`filter(Filter filter)` See `Query.Builder`
`WeDeploy`	`filter(java.lang.String field, java.lang.Object value)` See `Query.Builder`
`WeDeploy`	`filter(java.lang.String field, java.lang.String operator, java.lang.Object value)` See `Query.Builder`
`java.lang.Object`	`form(java.lang.String name)` Gets the form parameter.
`WeDeploy`	`form(java.lang.String name, java.lang.Object value)` Sets the form parameter.
`MultiMap<java.lang.Object>`	`forms()` Returns the form parameter.
`Response`	`get()` Executes GET request.
`Response`	`get(java.lang.Object body)` Executes GET request.
`Response`	`get(java.lang.String body)` Executes GET request.
`java.util.concurrent.CompletableFuture<Response>`	`getAsync()` Executes GET request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`getAsync(java.lang.Object body)` Executes GET request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`getAsync(java.lang.String body)` Executes GET request asynchronously.
`Response`	`head()` Executes HEAD request.
`Response`	`head(java.lang.Object body)` Executes HEAD request.
`Response`	`head(java.lang.String body)` Executes HEAD request.
`java.util.concurrent.CompletableFuture<Response>`	`headAsync()` Executes HEAD request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`headAsync(java.lang.Object body)` Serializes object and executes HEAD request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`headAsync(java.lang.String body)` Executes HEAD request asynchronously.
`WeDeploy`	`header(java.lang.String name, java.lang.String value)` Adds new header.
`WeDeploy`	`highlight(java.lang.String field)` See `Query.Builder`
`WeDeploy`	`limit(int limit)` See `Query.Builder`
`WeDeploy`	`offset(int offset)` See `Query.Builder`
`Response`	`option()` Executes OPTION request.
`Response`	`option(java.lang.Object body)` Executes OPTION request.
`Response`	`option(java.lang.String body)` Executes OPTION request.
`java.util.concurrent.CompletableFuture<Response>`	`optionAsync()` Executes OPTION request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`optionAsync(java.lang.Object body)` Serializes object and executes OPTION request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`optionAsync(java.lang.String body)` Executes OPTION request asynchronously.
`WeDeploy`	`param(java.lang.String name, java.lang.Object value)` Serializes an object using JSON serializer and sets query parameter.
`WeDeploy`	`param(java.lang.String name, java.lang.String value)` Sets a query parameter.
`Response`	`patch()` Executes PATCH request.
`Response`	`patch(java.lang.Object body)` Executes PATCH request.
`Response`	`patch(java.lang.String body)` Executes PATCH request.
`java.util.concurrent.CompletableFuture<Response>`	`patchAsync()` Executes PATCH request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`patchAsync(java.lang.Object body)` Serializes object and executes PATCH request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`patchAsync(java.lang.String body)` Executes PATCH request asynchronously.
`WeDeploy`	`path(java.lang.String... paths)` Creates new `WeDeploy`.
`WeDeploy`	`path(java.lang.String path)` Creates new `WeDeploy`.
`Response`	`post()` Executes POST request.
`Response`	`post(java.lang.Object body)` Executes POST request.
`Response`	`post(java.lang.String body)` Executes POST request.
`java.util.concurrent.CompletableFuture<Response>`	`postAsync()` Executes POST request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`postAsync(java.lang.Object body)` Serializes object and executes POST request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`postAsync(java.lang.String body)` Executes POST request asynchronously.
`Response`	`put()` Executes PUT request.
`Response`	`put(java.lang.Object body)` Executes PUT request.
`Response`	`put(java.lang.String body)` Executes PUT request.
`java.util.concurrent.CompletableFuture<Response>`	`putAsync()` Executes PUT request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`putAsync(java.lang.Object body)` Serializes object and PUT request asynchronously.
`java.util.concurrent.CompletableFuture<Response>`	`putAsync(java.lang.String body)` Executes PUT request asynchronously.
`protected void`	`resolveAuthentication(Request request)` Resolves authentication.
`protected java.lang.String`	`resolveBodyString(java.lang.Object body)` Resolves body string from body object.
`protected RequestImpl`	`resolveRequest(java.lang.String methodName, java.lang.String body)` Creates new request implementation.
`protected RequestImpl`	`resolveRequest(java.lang.String methodName, java.lang.String body, boolean convertBody)`
`protected Transport`	`resolveTransport()` Resolves transport.
`WeDeploy`	`search(Filter filter)` See `Query.Builder`
`WeDeploy`	`search(java.lang.String text)` See `Query.Builder`
`WeDeploy`	`search(java.lang.String field, java.lang.String text)` See `Query.Builder`
`WeDeploy`	`search(java.lang.String field, java.lang.String operator, java.lang.Object value)` See `Query.Builder`
`protected Response`	`send(java.lang.String methodName, java.lang.Object body)` Serializes input object to a JSON string and `sends it`.
`protected Response`	`send(java.lang.String methodName, java.lang.String body)` Uses transport to send request with given method name and body synchronously.
`protected java.util.concurrent.CompletableFuture<Response>`	`sendAsync(java.lang.String methodName, java.lang.Object body)` Serializes input object to a JSON string and `sends it`.
`protected java.util.concurrent.CompletableFuture<Response>`	`sendAsync(java.lang.String methodName, java.lang.String body)` Uses transport to send request with given method name and body asynchronously.
`WeDeploy`	`sort(java.lang.String field)` See `Query.Builder`
`WeDeploy`	`sort(java.lang.String field, java.lang.String direction)` See `Query.Builder`
`java.lang.String`	`url()` Returns full URL.
`static WeDeploy`	`url(java.lang.String url)` Static factory for creating WeDeploy client.
`WeDeploy`	`use(Transport transport)` Specifies `Transport` implementation.
`RealTime`	`watch()` Creates new socket.io instance.
`RealTime`	`watch(java.lang.Object body)`
`RealTime`	`watch(java.lang.Object body, java.util.Map<java.lang.String,java.lang.Object> options)`
`RealTime`	`watch(java.lang.String body)`
`RealTime`	`watch(java.lang.String body, java.util.Map<java.lang.String,java.lang.Object> options)`

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

Field Detail

MASTER_TOKEN

public static java.lang.String MASTER_TOKEN

METHOD_DELETE

public static final java.lang.String METHOD_DELETE

See Also:: Constant Field Values

METHOD_GET

public static final java.lang.String METHOD_GET

See Also:: Constant Field Values

METHOD_HEAD

public static final java.lang.String METHOD_HEAD

See Also:: Constant Field Values

METHOD_OPTION

public static final java.lang.String METHOD_OPTION

See Also:: Constant Field Values

METHOD_PATCH

public static final java.lang.String METHOD_PATCH

See Also:: Constant Field Values

METHOD_POST

public static final java.lang.String METHOD_POST

See Also:: Constant Field Values

METHOD_PUT

public static final java.lang.String METHOD_PUT

See Also:: Constant Field Values

auth
```
protected Auth auth
```

cookies

protected final java.util.List<Cookie> cookies

currentTransport
```
protected Transport currentTransport
```

forms

protected final MultiMap<java.lang.Object> forms

headers

protected final MultiMap<java.lang.String> headers

params

protected final MultiMap<java.lang.String> params

query
```
protected Query.Builder query
```

url
```
protected final java.lang.String url
```

Constructor Detail
- WeDeploy
```
public WeDeploy(java.lang.String url)
```
  Main constructor.
- WeDeploy
```
protected WeDeploy(java.lang.String baseUrl,
                   java.lang.String url)
```
  Continuations constructor, used from existing instance, therefore no need to configure the client.

Method Detail

url

public static WeDeploy url(java.lang.String url)

Static factory for creating WeDeploy client.

aggregate

public WeDeploy aggregate(Aggregation aggregation)

See Query.Builder

aggregate

public WeDeploy aggregate(java.lang.String name,
                          java.lang.String field,
                          java.lang.String operator)

See Query.Builder

auth
```
public WeDeploy auth(Auth auth)
```
Authenticates with an auth instance.

auth

public WeDeploy auth(java.lang.String token)

Authenticates with token.

auth

public WeDeploy auth(java.lang.String username,
                     java.lang.String password)

contentType

public WeDeploy contentType(ContentType contentType)

Sets the content type header of the request.

cookie

public WeDeploy cookie(Cookie cookie)

count
```
public WeDeploy count()
```
See Query.Builder

delete
```
public Response delete()
```
Executes DELETE request.

delete

public Response delete(java.lang.Object body)

Executes DELETE request.

delete

public Response delete(java.lang.String body)

Executes DELETE request.

deleteAsync

public java.util.concurrent.CompletableFuture<Response> deleteAsync()

Executes DELETE request asynchronously.

deleteAsync

public java.util.concurrent.CompletableFuture<Response> deleteAsync(java.lang.Object body)

Serializes object and executes DELETE request asynchronously.

deleteAsync

public java.util.concurrent.CompletableFuture<Response> deleteAsync(java.lang.String body)

Executes DELETE request asynchronously.

filter

public WeDeploy filter(Filter filter)

See Query.Builder

filter

public WeDeploy filter(java.lang.String field,
                       java.lang.Object value)

See Query.Builder

filter

public WeDeploy filter(java.lang.String field,
                       java.lang.String operator,
                       java.lang.Object value)

See Query.Builder

form

public java.lang.Object form(java.lang.String name)

Gets the form parameter.

form

public WeDeploy form(java.lang.String name,
                     java.lang.Object value)

Sets the form parameter.

forms

public MultiMap<java.lang.Object> forms()

Returns the form parameter.

get
```
public Response get()
```
Executes GET request.

get

public Response get(java.lang.Object body)

Executes GET request.

get

public Response get(java.lang.String body)

Executes GET request.

getAsync

public java.util.concurrent.CompletableFuture<Response> getAsync()

Executes GET request asynchronously.

getAsync

public java.util.concurrent.CompletableFuture<Response> getAsync(java.lang.Object body)

Executes GET request asynchronously.

getAsync

public java.util.concurrent.CompletableFuture<Response> getAsync(java.lang.String body)

Executes GET request asynchronously.

head
```
public Response head()
```
Executes HEAD request.

head

public Response head(java.lang.Object body)

Executes HEAD request.

head

public Response head(java.lang.String body)

Executes HEAD request.

headAsync

public java.util.concurrent.CompletableFuture<Response> headAsync()

Executes HEAD request asynchronously.

headAsync

public java.util.concurrent.CompletableFuture<Response> headAsync(java.lang.Object body)

Serializes object and executes HEAD request asynchronously.

headAsync

public java.util.concurrent.CompletableFuture<Response> headAsync(java.lang.String body)

Executes HEAD request asynchronously.

header
```
public WeDeploy header(java.lang.String name,
                       java.lang.String value)
```
Adds new header. If the header with the same name already exists, it will not be overwritten, but new value will be stored. The order is preserved.

highlight

public WeDeploy highlight(java.lang.String field)

See Query.Builder

limit
```
public WeDeploy limit(int limit)
```
See Query.Builder

offset
```
public WeDeploy offset(int offset)
```
See Query.Builder

option
```
public Response option()
```
Executes OPTION request.

option

public Response option(java.lang.Object body)

Executes OPTION request.

option

public Response option(java.lang.String body)

Executes OPTION request.

optionAsync

public java.util.concurrent.CompletableFuture<Response> optionAsync()

Executes OPTION request asynchronously.

optionAsync

public java.util.concurrent.CompletableFuture<Response> optionAsync(java.lang.Object body)

Serializes object and executes OPTION request asynchronously.

optionAsync

public java.util.concurrent.CompletableFuture<Response> optionAsync(java.lang.String body)

Executes OPTION request asynchronously.

param

public WeDeploy param(java.lang.String name,
                      java.lang.Object value)

Serializes an object using JSON serializer and sets query parameter.

param
```
public WeDeploy param(java.lang.String name,
                      java.lang.String value)
```
Sets a query parameter. If the parameter with the same name already exists, it will be overwritten.

patch
```
public Response patch()
```
Executes PATCH request.

patch

public Response patch(java.lang.Object body)

Executes PATCH request.

patch

public Response patch(java.lang.String body)

Executes PATCH request.

patchAsync

public java.util.concurrent.CompletableFuture<Response> patchAsync()

Executes PATCH request asynchronously.

patchAsync

public java.util.concurrent.CompletableFuture<Response> patchAsync(java.lang.Object body)

Serializes object and executes PATCH request asynchronously.

patchAsync

public java.util.concurrent.CompletableFuture<Response> patchAsync(java.lang.String body)

Executes PATCH request asynchronously.

path

public WeDeploy path(java.lang.String path)

Creates new WeDeploy.

path

public WeDeploy path(java.lang.String... paths)

Creates new WeDeploy.

post
```
public Response post()
```
Executes POST request.

post

public Response post(java.lang.Object body)

Executes POST request.

post

public Response post(java.lang.String body)

Executes POST request.

postAsync

public java.util.concurrent.CompletableFuture<Response> postAsync()

Executes POST request asynchronously.

postAsync

public java.util.concurrent.CompletableFuture<Response> postAsync(java.lang.Object body)

Serializes object and executes POST request asynchronously.

postAsync

public java.util.concurrent.CompletableFuture<Response> postAsync(java.lang.String body)

Executes POST request asynchronously.

put
```
public Response put()
```
Executes PUT request.

put

public Response put(java.lang.Object body)

Executes PUT request.

put

public Response put(java.lang.String body)

Executes PUT request.

putAsync

public java.util.concurrent.CompletableFuture<Response> putAsync()

Executes PUT request asynchronously.

putAsync

public java.util.concurrent.CompletableFuture<Response> putAsync(java.lang.Object body)

Serializes object and PUT request asynchronously.

putAsync

public java.util.concurrent.CompletableFuture<Response> putAsync(java.lang.String body)

Executes PUT request asynchronously.

search

public WeDeploy search(Filter filter)

See Query.Builder

search

public WeDeploy search(java.lang.String text)

See Query.Builder

search

public WeDeploy search(java.lang.String field,
                       java.lang.String text)

See Query.Builder

search

public WeDeploy search(java.lang.String field,
                       java.lang.String operator,
                       java.lang.Object value)

See Query.Builder

sort

public WeDeploy sort(java.lang.String field)

See Query.Builder

sort

public WeDeploy sort(java.lang.String field,
                     java.lang.String direction)

See Query.Builder

url
```
public java.lang.String url()
```
Returns full URL.

use

public WeDeploy use(Transport transport)

Specifies Transport implementation.

watch
```
public RealTime watch()
```
Creates new socket.io instance.

watch

public RealTime watch(java.lang.Object body)

watch

public RealTime watch(java.lang.Object body,
                      java.util.Map<java.lang.String,java.lang.Object> options)

watch

public RealTime watch(java.lang.String body)

watch

public RealTime watch(java.lang.String body,
                      java.util.Map<java.lang.String,java.lang.Object> options)

resolveAuthentication

protected void resolveAuthentication(Request request)

Resolves authentication.

resolveBodyString
```
protected java.lang.String resolveBodyString(java.lang.Object body)
```
Resolves body string from body object. If object is null, null will be returned. Object is serialized using the existing content type. If content type is not set, JSON is assumed; and will be set as content type as well.

resolveRequest

protected RequestImpl resolveRequest(java.lang.String methodName,
                                     java.lang.String body)

Creates new request implementation. Prepares method name, body and header and parameters map.

resolveRequest

protected RequestImpl resolveRequest(java.lang.String methodName,
                                     java.lang.String body,
                                     boolean convertBody)

resolveTransport
```
protected Transport resolveTransport()
```
Resolves transport. Throws exception if transport is missing.

send

protected Response send(java.lang.String methodName,
                        java.lang.Object body)

Serializes input object to a JSON string and sends it.

send

protected Response send(java.lang.String methodName,
                        java.lang.String body)

Uses transport to send request with given method name and body synchronously.

sendAsync

protected java.util.concurrent.CompletableFuture<Response> sendAsync(java.lang.String methodName,
                                                                     java.lang.Object body)

Serializes input object to a JSON string and sends it.

sendAsync

protected java.util.concurrent.CompletableFuture<Response> sendAsync(java.lang.String methodName,
                                                                     java.lang.String body)

Uses transport to send request with given method name and body asynchronously.

Class WeDeploy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MASTER_TOKEN

METHOD_DELETE

METHOD_GET

METHOD_HEAD

METHOD_OPTION

METHOD_PATCH

METHOD_POST

METHOD_PUT

auth

cookies

currentTransport

forms

headers

params

query

url

Constructor Detail

WeDeploy

WeDeploy

Method Detail

url

aggregate

aggregate

auth

auth

auth

contentType

cookie

count

delete

delete

delete

deleteAsync

deleteAsync

deleteAsync

filter

filter

filter

form

form

forms

get

get

get

getAsync

getAsync

getAsync

head

head

head

headAsync

headAsync

headAsync

header

highlight

limit

offset

option

option

option

optionAsync

optionAsync

optionAsync

param

param

patch

patch

patch

patchAsync

patchAsync

patchAsync

path

path

post