com.google.api.ads.adwords.jaxws.utils.v201710

Class ServiceQueryBuilderImpl

java.lang.Object

com.google.api.ads.adwords.lib.utils.QueryBuilder<ServiceQueryBuilderImpl,ServiceQueryInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page>>

com.google.api.ads.adwords.jaxws.utils.v201710.ServiceQueryBuilderImpl

All Implemented Interfaces:

QueryBuilderInterface<ServiceQueryInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page>>, ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

public class ServiceQueryBuilderImpl
extends QueryBuilder<ServiceQueryBuilderImpl,ServiceQueryInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page>>
implements ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Builds a ServiceQuery object.

This builder is not thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.ads.adwords.lib.utils.QueryBuilder

QueryBuilder.WhereBuilder

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

ServiceQueryInterface.BuilderInterface.ServiceWhereBuilderInterface<PageT,SortOrderT,BuilderT extends ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>>

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

QueryBuilderInterface.WhereBuilderInterface<QueryT>

Field Summary

Fields inherited from class com.google.api.ads.adwords.lib.utils.QueryBuilder

whereBuilders

Method Summary

Modifier and Type	Method and Description
ServiceQuery	build() Builds the query from the attributes of this builder.
ServiceQuery.Builder	fields(EntityField... fields) Selects the provided fields for building as a query.
ServiceQuery.Builder	fields(Iterable<String> fields) Selects the provided fields for building a report query.
ServiceQuery.Builder	fields(String... fields) Selects the provided fields for building as a query.
ServiceQuery.Builder	limit(int startIndex, int pageSize) Specifies the LIMIT clause using the provided start index and page size.
ServiceQuery.Builder	orderBy(EntityField field) Adds the provided field to the order-by list.
ServiceQuery.Builder	orderBy(EntityField field, com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder order) Adds the provided field to the order-by list with the provided order direction.
ServiceQuery.Builder	orderBy(String field) Adds the provided field to the order-by list.
ServiceQuery.Builder	orderBy(String field, com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder order) Adds the provided field to the order-by list with the provided order direction.
com.google.api.ads.adwords.jaxws.utils.v201710.ServiceQueryBuilderImpl.ServiceWhereBuilder	where(EntityField field) Set the condition of this query as the WHERE clause.
com.google.api.ads.adwords.jaxws.utils.v201710.ServiceQueryBuilderImpl.ServiceWhereBuilder	where(String field) Set the condition of this query as the WHERE clause.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

where

public com.google.api.ads.adwords.jaxws.utils.v201710.ServiceQueryBuilderImpl.ServiceWhereBuilder where(EntityField field)

Description copied from interface: ServiceQueryInterface.BuilderInterface

Set the condition of this query as the WHERE clause.

Specified by:

where in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Parameters:

field - the field of the given entity to be filtered on

Returns:

the WHERE builder to create a predicate

where

public com.google.api.ads.adwords.jaxws.utils.v201710.ServiceQueryBuilderImpl.ServiceWhereBuilder 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<com.google.api.ads.adwords.jaxws.v201710.cm.Page>>

Specified by:

where in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Parameters:

field - the field of the given entity to be filtered on

Returns:

the WHERE builder to create a predicate

fields

public ServiceQuery.Builder fields(EntityField... fields)

Description copied from interface: ServiceQueryInterface.BuilderInterface

Selects the provided fields for building as a query.

Specified by:

fields in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Parameters:

fields - the provided fields to be selected

Returns:

this query builder itself for method chaining

fields

public ServiceQuery.Builder fields(String... fields)

Description copied from interface: QueryBuilderInterface

Selects the provided fields for building as a query.

Specified by:

fields in interface QueryBuilderInterface<ServiceQueryInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page>>

Specified by:

fields in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Parameters:

fields - the provided fields to be selected

Returns:

this query builder itself for method chaining

fields

public ServiceQuery.Builder 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<com.google.api.ads.adwords.jaxws.v201710.cm.Page>>

Specified by:

fields in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Parameters:

fields - the fields to be selected

Returns:

this builder itself for method chaining

orderBy

public ServiceQuery.Builder orderBy(EntityField field)

Description copied from interface: ServiceQueryInterface.BuilderInterface

Adds the provided field to the order-by list.

Specified by:

orderBy in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Parameters:

field - the field to be added to the ORDER BY list

Returns:

this builder itself for method chaining

orderBy

public ServiceQuery.Builder orderBy(EntityField field,
                                    com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder order)

Description copied from interface: ServiceQueryInterface.BuilderInterface

Adds the provided field to the order-by list with the provided order direction.

Specified by:

orderBy in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Parameters:

field - the field to be added to the ORDER BY list

Returns:

this builder itself for method chaining

orderBy

public ServiceQuery.Builder orderBy(String field)

Description copied from interface: ServiceQueryInterface.BuilderInterface

Adds the provided field to the order-by list.

Specified by:

orderBy in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Parameters:

field - the field to be added to the ORDER BY list

Returns:

this builder itself for method chaining

orderBy

public ServiceQuery.Builder orderBy(String field,
                                    com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder order)

Description copied from interface: ServiceQueryInterface.BuilderInterface

Adds the provided field to the order-by list with the provided order direction.

Specified by:

orderBy in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Parameters:

field - the field to be added to the ORDER BY list

Returns:

this builder itself for method chaining

limit

public ServiceQuery.Builder limit(int startIndex,
                                  int pageSize)

Description copied from interface: ServiceQueryInterface.BuilderInterface

Specifies the LIMIT clause using the provided start index and page size.

Specified by:

limit in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

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

build

public ServiceQuery build()

Description copied from interface: QueryBuilderInterface

Builds the query from the attributes of this builder.

Specified by:

build in interface QueryBuilderInterface<ServiceQueryInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page>>

Specified by:

build in interface ServiceQueryInterface.BuilderInterface<com.google.api.ads.adwords.jaxws.v201710.cm.Page,com.google.api.ads.adwords.jaxws.v201710.cm.SortOrder>

Returns:

the built query object