com.opsmatters.bitly.api.model.v4

Class BitlinkQuery.Builder

java.lang.Object

com.opsmatters.bitly.api.model.v4.BitlinkQuery.Builder

Enclosing class:

BitlinkQuery

public static class BitlinkQuery.Builder
extends Object

Builder to make query construction easier.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BitlinkQuery.Builder	archived(Switch archived) Sets whether or not to include archived bitlinks.
BitlinkQuery	build() Returns the configured query
BitlinkQuery.Builder	campaignGuid(String campaignGuid) Sets filter to return only links for the given campaign GUID.
BitlinkQuery.Builder	channelGuid(String channelGuid) Sets filter to return only links for the given channel GUID, overrides all other parameters.
BitlinkQuery.Builder	createdAfter(int createdAfter) Sets the timestamp as an integer unix epoch.
BitlinkQuery.Builder	createdBefore(int createdBefore) Sets the timestamp as an integer unix epoch.
BitlinkQuery.Builder	customBitlink(Switch customBitlink) Sets whether to filter to only bitlinks that are custom bitlinks.
BitlinkQuery.Builder	deeplinks(Switch deeplinks) Sets whether to filter to only bitlinks that contain deeplinks.
BitlinkQuery.Builder	domainDeeplinks(Switch domainDeeplinks) Sets whether to filter to only bitlinks that contain deeplinks configured with a custom domain.
BitlinkQuery.Builder	encodingLogin(List<String> encodingLogin) Sets filter by the login of the authenticated user that created the bitlink.
BitlinkQuery.Builder	keyword(String keyword) Sets the custom keyword for the query.
BitlinkQuery.Builder	modifiedAfter(int modifiedAfter) Sets the timestamp as an integer unix epoch.
BitlinkQuery.Builder	page(int page) Sets the start page for the query.
BitlinkQuery.Builder	query(String value) Sets the search value for the query.
BitlinkQuery.Builder	size(int size) Sets the size for the query.
BitlinkQuery.Builder	tags(List<String> tags) Sets filter on the bitlink tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

size

public BitlinkQuery.Builder size(int size)

Sets the size for the query.

Parameters:

size - The size for the query

Returns:

This object

page

public BitlinkQuery.Builder page(int page)

Sets the start page for the query.

Parameters:

page - The start page for the query

Returns:

This object

keyword

public BitlinkQuery.Builder keyword(String keyword)

Sets the custom keyword for the query.

Parameters:

keyword - The custom keyword for the query

Returns:

This object

query

public BitlinkQuery.Builder query(String value)

Sets the search value for the query.

Parameters:

value - The search value for the query

Returns:

This object

createdBefore

public BitlinkQuery.Builder createdBefore(int createdBefore)

Sets the timestamp as an integer unix epoch.

Parameters:

createdBefore - The timestamp

Returns:

This object

createdAfter

public BitlinkQuery.Builder createdAfter(int createdAfter)

Sets the timestamp as an integer unix epoch.

Parameters:

createdAfter - The timestamp

Returns:

This object

modifiedAfter

public BitlinkQuery.Builder modifiedAfter(int modifiedAfter)

Sets the timestamp as an integer unix epoch.

Parameters:

modifiedAfter - The timestamp

Returns:

This object

archived

public BitlinkQuery.Builder archived(Switch archived)

Sets whether or not to include archived bitlinks.

Parameters:

archived - whether or not to include archived bitlinks

Returns:

This object

deeplinks

public BitlinkQuery.Builder deeplinks(Switch deeplinks)

Sets whether to filter to only bitlinks that contain deeplinks.

Parameters:

deeplinks - whether to filter to only bitlinks that contain deeplinks

Returns:

This object

domainDeeplinks

public BitlinkQuery.Builder domainDeeplinks(Switch domainDeeplinks)

Sets whether to filter to only bitlinks that contain deeplinks configured with a custom domain.

Parameters:

domainDeeplinks - whether to filter to only bitlinks that contain deeplinks configured with a custom domain

Returns:

This object

customBitlink

public BitlinkQuery.Builder customBitlink(Switch customBitlink)

Sets whether to filter to only bitlinks that are custom bitlinks.

Parameters:

customBitlink - whether to filter to only bitlinks that are custom bitlinks

Returns:

This object

campaignGuid

public BitlinkQuery.Builder campaignGuid(String campaignGuid)

Sets filter to return only links for the given campaign GUID.

Parameters:

campaignGuid - filter to return only links for the given campaign GUID

Returns:

This object

channelGuid

public BitlinkQuery.Builder channelGuid(String channelGuid)

Sets filter to return only links for the given channel GUID, overrides all other parameters.

Parameters:

channelGuid - filter to return only links for the given channel GUID

Returns:

This object

tags

public BitlinkQuery.Builder tags(List<String> tags)

Sets filter on the bitlink tags.

Parameters:

tags - filter on the bitlink tags

Returns:

This object

encodingLogin

public BitlinkQuery.Builder encodingLogin(List<String> encodingLogin)

Sets filter by the login of the authenticated user that created the bitlink.

Parameters:

encodingLogin - filter by the login of the authenticated user that created the bitlink

Returns:

This object

build

public BitlinkQuery build()

Returns the configured query

Returns:

The query instance