SelectorBuilder (Google Ads APIs Java Client Libraries Parent 1.24.1 API)

java.lang.Object
- com.google.api.ads.adwords.axis.utils.v201309.SelectorBuilder

```
public class SelectorBuilder
extends Object
```
A builder for Selector objects. This builder is not thread safe.

Author:

Gustavo Moreira

Field Summary

Fields
Modifier and Type Field and Description

protected static String DEFAULT_DATE_FORMAT
The default date format for the AdWords API

Fields
Modifier and Type	Field and Description
`protected static String`	`DEFAULT_DATE_FORMAT` The default date format for the AdWords API

Constructor Summary

Constructors
Constructor and Description

SelectorBuilder()

Constructors
Constructor and Description
`SelectorBuilder()`

Method Summary

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

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

- Field Detail
  - DEFAULT_DATE_FORMAT
```
protected static final String DEFAULT_DATE_FORMAT
```
    The default date format for the AdWords API
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SelectorBuilder
```
public SelectorBuilder()
```
- Method Detail
  - build
```
public com.google.api.ads.adwords.axis.v201309.cm.Selector 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
```
public SelectorBuilder 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.
  - increaseOffsetBy
```
public SelectorBuilder 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
```
public SelectorBuilder 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
```
public SelectorBuilder 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
```
public SelectorBuilder removeLimitAndOffset()
```
    Removes the offset and limit information from the selector.
    
    Returns:
    the builder itself to proceed the chain.
  - orderAscBy
```
public SelectorBuilder orderAscBy(String field)
```
    Adds the order by the given field, on ASCENDING sort.
    
    Returns:
    the builder itself to proceed the chain.
  - orderDescBy
```
public SelectorBuilder orderDescBy(String field)
```
    Adds the order by the given field, on DESCENDING sort.
    
    Returns:
    the builder itself to proceed the chain.
  - removeOrderBy
```
public SelectorBuilder removeOrderBy(String field)
```
    Removes the order that is associated with the given field.
    
    Returns:
    the builder itself to proceed the chain.
  - forDateRange
```
public SelectorBuilder 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
```
public SelectorBuilder 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.
  - notEquals
```
public SelectorBuilder 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
  - contains
```
public SelectorBuilder 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
  - containsIgnoreCase
```
public SelectorBuilder 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
  - doesNotContain
```
public SelectorBuilder 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
  - doesNotContainIgnoreCase
```
public SelectorBuilder 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
  - greaterThan
```
public SelectorBuilder 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
  - greaterThanEquals
```
public SelectorBuilder 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
  - lessThan
```
public SelectorBuilder 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
  - lessThanEquals
```
public SelectorBuilder 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
  - equalsId
```
public SelectorBuilder 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
```
public SelectorBuilder 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.
  - notIn
```
public SelectorBuilder 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.

Class SelectorBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DATE_FORMAT

Constructor Detail

SelectorBuilder

Method Detail

build

fields

increaseOffsetBy

limit

offset

removeLimitAndOffset

orderAscBy

orderDescBy

removeOrderBy

forDateRange

equals

notEquals

contains

containsIgnoreCase

doesNotContain

doesNotContainIgnoreCase

greaterThan

greaterThanEquals

lessThan

lessThanEquals

equalsId

in

notIn