SelectorBuilderInterface (Google Ads APIs Client Library for Java parent 3.12.0 API)

All Known Implementing Classes:

SelectorBuilder, SelectorBuilder, SelectorBuilder, SelectorBuilder, SelectorBuilder, SelectorBuilder, SelectorBuilder, SelectorBuilder
```
public interface SelectorBuilderInterface<SelectorT>
```
A builder for Selector objects.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`SelectorT`	`build()` Builds a new Selector.
`SelectorBuilderInterface<SelectorT>`	`contains(EntityField field, String propertyValue)` Adds the predicate contains to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`contains(String field, String propertyValue)` Adds the predicate contains to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`containsAll(EntityField field, String... values)` Adds the predicate contains all to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`containsAll(String field, String... values)` Adds the predicate contains all to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`containsAny(EntityField field, String... values)` Adds the predicate contains any to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`containsAny(String field, String... values)` Adds the predicate contains any to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`containsIgnoreCase(EntityField field, String propertyValue)` Adds the predicate contains ignore case to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`containsIgnoreCase(String field, String propertyValue)` Adds the predicate contains ignore case to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`containsNone(EntityField field, String... values)` Adds the predicate contains none to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`containsNone(String field, String... values)` Adds the predicate contains none to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`doesNotContain(EntityField field, String propertyValue)` Adds the predicate does not contain to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`doesNotContain(String field, String propertyValue)` Adds the predicate does not contain to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`doesNotContainIgnoreCase(EntityField field, String propertyValue)` Adds the predicate does not contain ignore case to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`doesNotContainIgnoreCase(String field, String propertyValue)` Adds the predicate does not contain ignore case to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`equals(EntityField field, String propertyValue)` Adds the predicate equals to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`equals(String field, String propertyValue)` Adds the predicate equals to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`equalsId(Long id)` Adds the predicate equals to the selector for the entity Id and the given id value.
`SelectorBuilderInterface<SelectorT>`	`fields(EntityField... fields)` Chooses the set of fields that will be selected via the API.
`SelectorBuilderInterface<SelectorT>`	`fields(String... fields)` Chooses the set of fields that will be selected via the API.
`SelectorBuilderInterface<SelectorT>`	`forDateRange(org.joda.time.DateTime start, org.joda.time.DateTime end)` Restricts the Selector by the date range.
`SelectorBuilderInterface<SelectorT>`	`greaterThan(EntityField field, long propertyValue)` Adds the predicate greater than to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`greaterThan(String field, long propertyValue)` Adds the predicate greater than to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`greaterThanEquals(EntityField field, long propertyValue)` Adds the predicate greater than equals to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`greaterThanEquals(String field, long propertyValue)` Adds the predicate greater than equals to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`in(EntityField field, String... values)` Adds the predicate in to the selector for the given field and set of values.
`SelectorBuilderInterface<SelectorT>`	`in(String field, String... values)` Adds the predicate in to the selector for the given field and set of values.
`SelectorBuilderInterface<SelectorT>`	`increaseOffsetBy(int additionalOffset)` Adds the given amount to the current offset.
`SelectorBuilderInterface<SelectorT>`	`lessThan(EntityField field, long propertyValue)` Adds the predicate less than to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`lessThan(String field, long propertyValue)` Adds the predicate less than to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`lessThanEquals(EntityField field, long propertyValue)` Adds the predicate less than equals to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`lessThanEquals(String field, long propertyValue)` Adds the predicate less than equals to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`limit(int limit)` Sets the limit amount of results that will be brought back.
`SelectorBuilderInterface<SelectorT>`	`notEquals(EntityField field, String propertyValue)` Adds the predicate not equals to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`notEquals(String field, String propertyValue)` Adds the predicate not equals to the selector for the given field and value.
`SelectorBuilderInterface<SelectorT>`	`notIn(EntityField field, String... values)` Adds the predicate not in to the selector for the given field and set of values.
`SelectorBuilderInterface<SelectorT>`	`notIn(String field, String... values)` Adds the predicate not in to the selector for the given field and set of values.
`SelectorBuilderInterface<SelectorT>`	`offset(int offset)` Sets the offset for the start point of the query.
`SelectorBuilderInterface<SelectorT>`	`orderAscBy(EntityField field)` Adds the order by the given field, on ASCENDING sort.
`SelectorBuilderInterface<SelectorT>`	`orderAscBy(String field)` Adds the order by the given field, on ASCENDING sort.
`SelectorBuilderInterface<SelectorT>`	`orderDescBy(EntityField field)` Adds the order by the given field, on DESCENDING sort.
`SelectorBuilderInterface<SelectorT>`	`orderDescBy(String field)` Adds the order by the given field, on DESCENDING sort.
`SelectorBuilderInterface<SelectorT>`	`removeLimitAndOffset()` Removes the offset and limit information from the selector.
`SelectorBuilderInterface<SelectorT>`	`removeOrderBy(EntityField field)` Removes the order that is associated with the given field.
`SelectorBuilderInterface<SelectorT>`	`removeOrderBy(String field)` Removes the order that is associated with the given field.

- Method Detail
  - build
```
SelectorT build()
```
    Builds a new Selector.
    When a Selector is built by this method, the state of the builder doesn't change. If you need to clean the builder, the best way to do it, is by creating a new instance.
    
    Returns:
    
    the new Selector containing all the configuration that was set previously.
  - fields
```
SelectorBuilderInterface<SelectorT> fields(String... fields)
```
    Chooses the set of fields that will be selected via the API.
    Calling this method multiple times will overwrite the previous fields that were set.
    
    Parameters:
    
    fields - the set of fields of the given entity.
    
    Returns:
    
    the builder itself to proceed the chain.
  - fields
```
SelectorBuilderInterface<SelectorT> fields(EntityField... fields)
```
    Chooses the set of fields that will be selected via the API.
    Calling this method multiple times will overwrite the previous fields that were set.
    
    Parameters:
    
    fields - the set of fields of the given entity as Java Enums.
    
    Returns:
    
    the builder itself to proceed the chain.
  - increaseOffsetBy
```
SelectorBuilderInterface<SelectorT> increaseOffsetBy(int additionalOffset)
```
    Adds the given amount to the current offset.
    
    Parameters:
    
    additionalOffset - the amount that will be added to the offset
    
    Returns:
    
    the builder itself to proceed the chain.
  - limit
```
SelectorBuilderInterface<SelectorT> limit(int limit)
```
    Sets the limit amount of results that will be brought back. Calling this method overrides the previous limit value.
    
    Returns:
    
    the builder itself to proceed the chain.
  - offset
```
SelectorBuilderInterface<SelectorT> offset(int offset)
```
    Sets the offset for the start point of the query. Calling this method overrides the previous offset value.
    
    Parameters:
    
    offset - the offset
    
    Returns:
    
    the builder itself to proceed the chain.
  - removeLimitAndOffset
```
SelectorBuilderInterface<SelectorT> removeLimitAndOffset()
```
    Removes the offset and limit information from the selector.
    
    Returns:
    
    the builder itself to proceed the chain.
  - orderAscBy
```
SelectorBuilderInterface<SelectorT> orderAscBy(String field)
```
    Adds the order by the given field, on ASCENDING sort.
    
    Returns:
    
    the builder itself to proceed the chain.
  - orderAscBy
```
SelectorBuilderInterface<SelectorT> orderAscBy(EntityField field)
```
    Adds the order by the given field, on ASCENDING sort.
    
    Returns:
    
    the builder itself to proceed the chain.
  - orderDescBy
```
SelectorBuilderInterface<SelectorT> orderDescBy(String field)
```
    Adds the order by the given field, on DESCENDING sort.
    
    Returns:
    
    the builder itself to proceed the chain.
  - orderDescBy
```
SelectorBuilderInterface<SelectorT> orderDescBy(EntityField field)
```
    Adds the order by the given field, on DESCENDING sort.
    
    Returns:
    
    the builder itself to proceed the chain.
  - removeOrderBy
```
SelectorBuilderInterface<SelectorT> removeOrderBy(String field)
```
    Removes the order that is associated with the given field.
    
    Returns:
    
    the builder itself to proceed the chain.
  - removeOrderBy
```
SelectorBuilderInterface<SelectorT> removeOrderBy(EntityField field)
```
    Removes the order that is associated with the given field.
    
    Returns:
    
    the builder itself to proceed the chain.
  - forDateRange
```
SelectorBuilderInterface<SelectorT> forDateRange(org.joda.time.DateTime start,
                                                 org.joda.time.DateTime end)
```
    Restricts the Selector by the date range.
    
    Returns:
    
    the builder itself to proceed the chain.
  - equals
```
SelectorBuilderInterface<SelectorT> equals(String field,
                                           String propertyValue)
```
    Adds the predicate equals to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
    
    Returns:
    
    the builder itself to proceed the chain.
  - equals
```
SelectorBuilderInterface<SelectorT> equals(EntityField field,
                                           String propertyValue)
```
    Adds the predicate equals to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
    
    Returns:
    
    the builder itself to proceed the chain.
  - notEquals
```
SelectorBuilderInterface<SelectorT> notEquals(String field,
                                              String propertyValue)
```
    Adds the predicate not equals to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - notEquals
```
SelectorBuilderInterface<SelectorT> notEquals(EntityField field,
                                              String propertyValue)
```
    Adds the predicate not equals to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - contains
```
SelectorBuilderInterface<SelectorT> contains(String field,
                                             String propertyValue)
```
    Adds the predicate contains to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - contains
```
SelectorBuilderInterface<SelectorT> contains(EntityField field,
                                             String propertyValue)
```
    Adds the predicate contains to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - containsIgnoreCase
```
SelectorBuilderInterface<SelectorT> containsIgnoreCase(String field,
                                                       String propertyValue)
```
    Adds the predicate contains ignore case to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - containsIgnoreCase
```
SelectorBuilderInterface<SelectorT> containsIgnoreCase(EntityField field,
                                                       String propertyValue)
```
    Adds the predicate contains ignore case to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - doesNotContain
```
SelectorBuilderInterface<SelectorT> doesNotContain(String field,
                                                   String propertyValue)
```
    Adds the predicate does not contain to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - doesNotContain
```
SelectorBuilderInterface<SelectorT> doesNotContain(EntityField field,
                                                   String propertyValue)
```
    Adds the predicate does not contain to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - doesNotContainIgnoreCase
```
SelectorBuilderInterface<SelectorT> doesNotContainIgnoreCase(String field,
                                                             String propertyValue)
```
    Adds the predicate does not contain ignore case to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - doesNotContainIgnoreCase
```
SelectorBuilderInterface<SelectorT> doesNotContainIgnoreCase(EntityField field,
                                                             String propertyValue)
```
    Adds the predicate does not contain ignore case to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - greaterThan
```
SelectorBuilderInterface<SelectorT> greaterThan(String field,
                                                long propertyValue)
```
    Adds the predicate greater than to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - greaterThan
```
SelectorBuilderInterface<SelectorT> greaterThan(EntityField field,
                                                long propertyValue)
```
    Adds the predicate greater than to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - greaterThanEquals
```
SelectorBuilderInterface<SelectorT> greaterThanEquals(String field,
                                                      long propertyValue)
```
    Adds the predicate greater than equals to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - greaterThanEquals
```
SelectorBuilderInterface<SelectorT> greaterThanEquals(EntityField field,
                                                      long propertyValue)
```
    Adds the predicate greater than equals to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - lessThan
```
SelectorBuilderInterface<SelectorT> lessThan(String field,
                                             long propertyValue)
```
    Adds the predicate less than to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - lessThan
```
SelectorBuilderInterface<SelectorT> lessThan(EntityField field,
                                             long propertyValue)
```
    Adds the predicate less than to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - lessThanEquals
```
SelectorBuilderInterface<SelectorT> lessThanEquals(String field,
                                                   long propertyValue)
```
    Adds the predicate less than equals to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - lessThanEquals
```
SelectorBuilderInterface<SelectorT> lessThanEquals(EntityField field,
                                                   long propertyValue)
```
    Adds the predicate less than equals to the selector for the given field and value.
    
    Parameters:
    
    propertyValue - the property value as a String independently of the field type. The caller should take care of the formatting if it is necessary
  - equalsId
```
SelectorBuilderInterface<SelectorT> equalsId(Long id)
```
    Adds the predicate equals to the selector for the entity Id and the given id value.
    
    Parameters:
    
    id - the ID of the current entity. This field represents different values for different entity types
    
    Returns:
    
    the builder itself to proceed the chain.
  - in
```
SelectorBuilderInterface<SelectorT> in(String field,
                                       String... values)
```
    Adds the predicate in to the selector for the given field and set of values.
    
    Returns:
    
    the builder itself to proceed the chain.
  - in
```
SelectorBuilderInterface<SelectorT> in(EntityField field,
                                       String... values)
```
    Adds the predicate in to the selector for the given field and set of values.
    
    Returns:
    
    the builder itself to proceed the chain.
  - notIn
```
SelectorBuilderInterface<SelectorT> notIn(String field,
                                          String... values)
```
    Adds the predicate not in to the selector for the given field and set of values.
    
    Returns:
    
    the builder itself to proceed the chain.
  - notIn
```
SelectorBuilderInterface<SelectorT> notIn(EntityField field,
                                          String... values)
```
    Adds the predicate not in to the selector for the given field and set of values.
    
    Returns:
    
    the builder itself to proceed the chain.
  - containsAny
```
SelectorBuilderInterface<SelectorT> containsAny(String field,
                                                String... values)
```
    Adds the predicate contains any to the selector for the given field and value.
    
    Returns:
    
    the builder itself to proceed the chain.
  - containsAny
```
SelectorBuilderInterface<SelectorT> containsAny(EntityField field,
                                                String... values)
```
    Adds the predicate contains any to the selector for the given field and value.
    
    Returns:
    
    the builder itself to proceed the chain.
  - containsAll
```
SelectorBuilderInterface<SelectorT> containsAll(String field,
                                                String... values)
```
    Adds the predicate contains all to the selector for the given field and value.
    
    Returns:
    
    the builder itself to proceed the chain.
  - containsAll
```
SelectorBuilderInterface<SelectorT> containsAll(EntityField field,
                                                String... values)
```
    Adds the predicate contains all to the selector for the given field and value.
    
    Returns:
    
    the builder itself to proceed the chain.
  - containsNone
```
SelectorBuilderInterface<SelectorT> containsNone(String field,
                                                 String... values)
```
    Adds the predicate contains none to the selector for the given field and value.
    
    Returns:
    
    the builder itself to proceed the chain.
  - containsNone
```
SelectorBuilderInterface<SelectorT> containsNone(EntityField field,
                                                 String... values)
```
    Adds the predicate contains none to the selector for the given field and value.
    
    Returns:
    
    the builder itself to proceed the chain.

Interface SelectorBuilderInterface<SelectorT>

Method Summary

Method Detail

build

fields

fields

increaseOffsetBy

limit

offset

removeLimitAndOffset

orderAscBy

orderAscBy

orderDescBy

orderDescBy

removeOrderBy

removeOrderBy

forDateRange

equals

equals

notEquals

notEquals

contains

contains

containsIgnoreCase

containsIgnoreCase

doesNotContain

doesNotContain

doesNotContainIgnoreCase

doesNotContainIgnoreCase

greaterThan

greaterThan

greaterThanEquals

greaterThanEquals

lessThan

lessThan

lessThanEquals

lessThanEquals

equalsId

in

in

notIn

notIn

containsAny

containsAny

containsAll

containsAll

containsNone

containsNone