EvrythngApiBuilder.CheckedBuilder (evrythng-java-wrapper 1.27 API)

java.lang.Object
- com.evrythng.java.wrapper.core.api.ApiCommandBuilder<T,EvrythngApiBuilder.CheckedBuilder<T>>
- - com.evrythng.java.wrapper.core.EvrythngApiBuilder.CheckedBuilder<T>

All Implemented Interfaces:

EvrythngApiBuilder.Builder<T>

Enclosing class:

EvrythngApiBuilder
```
public static class EvrythngApiBuilder.CheckedBuilder<T>
extends ApiCommandBuilder<T,EvrythngApiBuilder.CheckedBuilder<T>>
implements EvrythngApiBuilder.Builder<T>
```
Default command builder for the EVRYTHNG API.

Author:

Pedro De Almeida (almeidap)

Nested Class Summary
- Nested classes/interfaces inherited from interface com.evrythng.java.wrapper.core.EvrythngApiBuilder.Builder
  EvrythngApiBuilder.Builder.Result<R>

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`EvrythngApiBuilder.CheckedBuilder<T>`	`apiKey(String apiKey)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`app(String appId)` Deprecated.
`int`	`count()` Deprecated.
`EvrythngApiBuilder.CheckedBuilder<T>`	`filter(String filter)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`from(ApiConfiguration.QueryKeyword queryKeyword)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`from(long from)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`from(String from)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`ids(List<String> ids)`
`String`	`jsonp(String callback)` Executes the current command by requesting JSONP in the `HttpResponse` entity.
`EvrythngApiBuilder.Builder.Result<T>`	`list()` Executes the requests and returns a result object.
`EvrythngApiBuilder.CheckedBuilder<T>`	`page(int page)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`perPage(int perPage)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`project(String projectId)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`search(String pattern)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`to(ApiConfiguration.QueryKeyword queryKeyword)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`to(long to)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`to(String to)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`userScope(Iterable<String> scope)`
`EvrythngApiBuilder.CheckedBuilder<T>`	`userScopeAll()` Adds "" query param with value `ApiConfiguration.QueryKeyword.ALL`
`EvrythngApiBuilder.CheckedBuilder<T>`	`withPagination(int page, int perPage)` Combines page and perPage methods.
`EvrythngApiBuilder.CheckedBuilder<T>`	`withScopes(boolean withScopes)`

Methods inherited from class com.evrythng.java.wrapper.core.api.ApiCommandBuilder
accept, content, execute, executeWithResponse, getCommand, header, placeHolder, queryParam, queryParam, queryParam, queryParamList, queryParamList, queryParams, request, sortOrder, stream

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

Methods inherited from interface com.evrythng.java.wrapper.core.EvrythngApiBuilder.Builder
accept, content, execute, executeWithResponse, getCommand, header, placeHolder, queryParam, queryParam, queryParam, queryParamList, queryParamList, queryParams, request, sortOrder, stream

- Method Detail
  - apiKey
```
public EvrythngApiBuilder.CheckedBuilder<T> apiKey(String apiKey)
```
    Specified by:
    
    apiKey in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    apiKey - the authorization token for accessing the EVRYTHNG API
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - search
```
public EvrythngApiBuilder.CheckedBuilder<T> search(String pattern)
```
    Specified by:
    
    search in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    pattern - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
    
    See Also:
    
    QSearchQueryParamValue
  - withScopes
```
public EvrythngApiBuilder.CheckedBuilder<T> withScopes(boolean withScopes)
```
    Specified by:
    
    withScopes in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    withScopes - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
    
    See Also:
    
    WithScopesQueryParamValue
  - withPagination
```
public EvrythngApiBuilder.CheckedBuilder<T> withPagination(int page,
                                                           int perPage)
```
    Description copied from interface: EvrythngApiBuilder.Builder
    
    Combines page and perPage methods.
    
    Specified by:
    
    withPagination in interface EvrythngApiBuilder.Builder<T>
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - page
```
public EvrythngApiBuilder.CheckedBuilder<T> page(int page)
```
    Specified by:
    
    page in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    page - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - perPage
```
public EvrythngApiBuilder.CheckedBuilder<T> perPage(int perPage)
```
    Specified by:
    
    perPage in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    perPage - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - from
```
public EvrythngApiBuilder.CheckedBuilder<T> from(long from)
```
    Specified by:
    
    from in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    from - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - from
```
public EvrythngApiBuilder.CheckedBuilder<T> from(String from)
```
    Specified by:
    
    from in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    from - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - from
```
public EvrythngApiBuilder.CheckedBuilder<T> from(ApiConfiguration.QueryKeyword queryKeyword)
```
    Specified by:
    
    from in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    queryKeyword - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - to
```
public EvrythngApiBuilder.CheckedBuilder<T> to(long to)
```
    Specified by:
    
    to in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    to - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - to
```
public EvrythngApiBuilder.CheckedBuilder<T> to(String to)
```
    Specified by:
    
    to in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    to - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - to
```
public EvrythngApiBuilder.CheckedBuilder<T> to(ApiConfiguration.QueryKeyword queryKeyword)
```
    Specified by:
    
    to in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    queryKeyword - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - app
```
@Deprecated
public EvrythngApiBuilder.CheckedBuilder<T> app(String appId)
```
    Deprecated.
    
    Description copied from interface: EvrythngApiBuilder.Builder
    
    Does nothing. App query parameter is not used anymore.
    
    Specified by:
    
    app in interface EvrythngApiBuilder.Builder<T>
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - userScope
```
public EvrythngApiBuilder.CheckedBuilder<T> userScope(Iterable<String> scope)
```
    Specified by:
    
    userScope in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    scope - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - userScopeAll
```
public EvrythngApiBuilder.CheckedBuilder<T> userScopeAll()
```
    Description copied from interface: EvrythngApiBuilder.Builder
    
    Adds "" query param with value ApiConfiguration.QueryKeyword.ALL
    
    Specified by:
    
    userScopeAll in interface EvrythngApiBuilder.Builder<T>
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - ids
```
public EvrythngApiBuilder.CheckedBuilder<T> ids(List<String> ids)
```
    Specified by:
    
    ids in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    ids - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - filter
```
public EvrythngApiBuilder.CheckedBuilder<T> filter(String filter)
```
    Specified by:
    
    filter in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    filter - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - project
```
public EvrythngApiBuilder.CheckedBuilder<T> project(String projectId)
```
    Specified by:
    
    project in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    projectId - "" query parameter value
    
    Returns:
    
    an EVRYTHNG API-ready EvrythngApiBuilder.Builder
  - count
```
@Deprecated
public int count()
                      throws EvrythngException
```
    Deprecated.
    
    Description copied from interface: EvrythngApiBuilder.Builder
    
    Counts the total number of elements if the current command was executed as a HEAD request.
    
    Specified by:
    
    count in interface EvrythngApiBuilder.Builder<T>
    
    Returns:
    
    the total number of elements matching the current request
    
    Throws:
    
    EvrythngException
    
    See Also:
    
    ApiCommand.head(String)
  - list
```
public EvrythngApiBuilder.Builder.Result<T> list()
                                          throws EvrythngException
```
    Description copied from interface: EvrythngApiBuilder.Builder
    
    Executes the requests and returns a result object. The result objects contains the actual object and the total count for the paginated list. This method can only be used in the context of a paginated result set, otherwise an exception is thrown.
    
    Specified by:
    
    list in interface EvrythngApiBuilder.Builder<T>
    
    Returns:
    
    result object
    
    Throws:
    
    EvrythngException
  - jsonp
```
public String jsonp(String callback)
             throws EvrythngException
```
    Description copied from interface: EvrythngApiBuilder.Builder
    
    Executes the current command by requesting JSONP in the HttpResponse entity.
    
    Specified by:
    
    jsonp in interface EvrythngApiBuilder.Builder<T>
    
    Parameters:
    
    callback - the name of the callback function
    
    Returns:
    
    the HttpResponse entity in the form of JSONP content
    
    Throws:
    
    EvrythngException

Class EvrythngApiBuilder.CheckedBuilder<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.evrythng.java.wrapper.core.EvrythngApiBuilder.Builder

Method Summary

Methods inherited from class com.evrythng.java.wrapper.core.api.ApiCommandBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface com.evrythng.java.wrapper.core.EvrythngApiBuilder.Builder

Method Detail

apiKey

search

withScopes

withPagination

page

perPage

from

from

from

to

to

to

app

userScope

userScopeAll

ids

filter

project

count

list

jsonp