ServiceQueryInterface.BuilderInterface (Google Ads APIs Client Library for Java parent 3.12.0 API)

All Superinterfaces:

QueryBuilderInterface<ServiceQueryInterface<PageT>>

All Known Implementing Classes:

ServiceQuery.Builder, ServiceQuery.Builder, ServiceQuery.Builder, ServiceQuery.Builder, ServiceQueryBuilderImpl, ServiceQueryBuilderImpl, ServiceQueryBuilderImpl, ServiceQueryBuilderImpl

Enclosing interface:

ServiceQueryInterface<PageT>
```
public static interface ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>
extends QueryBuilderInterface<ServiceQueryInterface<PageT>>
```
Builds an AWQL query.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`ServiceQueryInterface.BuilderInterface.ServiceWhereBuilderInterface<PageT,SortOrderT,BuilderT extends ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>>` A builder for the WHERE clause of queries.

Nested classes/interfaces inherited from interface com.google.api.ads.adwords.lib.utils.QueryBuilderInterface
QueryBuilderInterface.WhereBuilderInterface<QueryT>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ServiceQueryInterface<PageT>`	`build()` Builds the query from the attributes of this builder.
`ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>`	`fields(EntityField... fields)` Selects the provided fields for building as a query.
`ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>`	`fields(Iterable<String> fields)` Selects the provided fields for building a report query.
`ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>`	`fields(String... fields)` Selects the provided fields for building as a query.
`ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>`	`limit(int startIndex, int pageSize)` Specifies the LIMIT clause using the provided start index and page size.
`ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>`	`orderBy(EntityField field)` Adds the provided field to the order-by list.
`ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>`	`orderBy(EntityField field, SortOrderT order)` Adds the provided field to the order-by list with the provided order direction.
`ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>`	`orderBy(String field)` Adds the provided field to the order-by list.
`ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>`	`orderBy(String field, SortOrderT order)` Adds the provided field to the order-by list with the provided order direction.
`ServiceQueryInterface.BuilderInterface.ServiceWhereBuilderInterface<PageT,SortOrderT,? extends ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>>`	`where(EntityField field)` Set the condition of this query as the WHERE clause.
`ServiceQueryInterface.BuilderInterface.ServiceWhereBuilderInterface<PageT,SortOrderT,? extends ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>>`	`where(String field)` Set the condition of this query as the WHERE clause.

- Method Detail
  - fields
```
ServiceQueryInterface.BuilderInterface<PageT,SortOrderT> fields(EntityField... fields)
```
    Selects the provided fields for building as a query.
    
    Parameters:
    
    fields - the provided fields to be selected
    
    Returns:
    
    this query builder itself for method chaining
  - fields
```
ServiceQueryInterface.BuilderInterface<PageT,SortOrderT> fields(String... fields)
```
    Description copied from interface: QueryBuilderInterface
    
    Selects the provided fields for building as a query.
    
    Specified by:
    
    fields in interface QueryBuilderInterface<ServiceQueryInterface<PageT>>
    
    Parameters:
    
    fields - the provided fields to be selected
    
    Returns:
    
    this query builder itself for method chaining
  - fields
```
ServiceQueryInterface.BuilderInterface<PageT,SortOrderT> fields(Iterable<String> fields)
```
    Description copied from interface: QueryBuilderInterface
    
    Selects the provided fields for building a report query.
    
    Specified by:
    
    fields in interface QueryBuilderInterface<ServiceQueryInterface<PageT>>
    
    Parameters:
    
    fields - the fields to be selected
    
    Returns:
    
    this builder itself for method chaining
  - where
```
ServiceQueryInterface.BuilderInterface.ServiceWhereBuilderInterface<PageT,SortOrderT,? extends ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>> where(EntityField field)
```
    Set the condition of this query as the WHERE clause.
    
    Parameters:
    
    field - the field of the given entity to be filtered on
    
    Returns:
    
    the WHERE builder to create a predicate
  - where
```
ServiceQueryInterface.BuilderInterface.ServiceWhereBuilderInterface<PageT,SortOrderT,? extends ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>> where(String field)
```
    Description copied from interface: QueryBuilderInterface
    
    Set the condition of this query as the WHERE clause.
    
    Specified by:
    
    where in interface QueryBuilderInterface<ServiceQueryInterface<PageT>>
    
    Parameters:
    
    field - the field of the given entity to be filtered on
    
    Returns:
    
    the WHERE builder to create a predicate
  - build
```
ServiceQueryInterface<PageT> build()
```
    Description copied from interface: QueryBuilderInterface
    
    Builds the query from the attributes of this builder.
    
    Specified by:
    
    build in interface QueryBuilderInterface<ServiceQueryInterface<PageT>>
    
    Returns:
    
    the built query object
  - orderBy
```
ServiceQueryInterface.BuilderInterface<PageT,SortOrderT> orderBy(EntityField field)
```
    Adds the provided field to the order-by list.
    
    Parameters:
    
    field - the field to be added to the ORDER BY list
    
    Returns:
    
    this builder itself for method chaining
  - orderBy
```
ServiceQueryInterface.BuilderInterface<PageT,SortOrderT> orderBy(EntityField field,
                                                                 SortOrderT order)
```
    Adds the provided field to the order-by list with the provided order direction.
    
    Parameters:
    
    field - the field to be added to the ORDER BY list
    
    Returns:
    
    this builder itself for method chaining
  - orderBy
```
ServiceQueryInterface.BuilderInterface<PageT,SortOrderT> orderBy(String field)
```
    Adds the provided field to the order-by list.
    
    Parameters:
    
    field - the field to be added to the ORDER BY list
    
    Returns:
    
    this builder itself for method chaining
  - orderBy
```
ServiceQueryInterface.BuilderInterface<PageT,SortOrderT> orderBy(String field,
                                                                 SortOrderT order)
```
    Adds the provided field to the order-by list with the provided order direction.
    
    Parameters:
    
    field - the field to be added to the ORDER BY list
    
    Returns:
    
    this builder itself for method chaining
  - limit
```
ServiceQueryInterface.BuilderInterface<PageT,SortOrderT> limit(int startIndex,
                                                               int pageSize)
```
    Specifies the LIMIT clause using the provided start index and page size.
    
    Parameters:
    
    startIndex - the specified start index for the LIMIT clause
    
    pageSize - the specified page size for the LIMIT clause
    
    Returns:
    
    this builder itself for method chaining

Interface ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.api.ads.adwords.lib.utils.QueryBuilderInterface

Method Summary

Method Detail

fields

fields

fields

where

where

build

orderBy

orderBy

orderBy

orderBy

limit