BitlinkQuery (Bitly Java API 1.0.2 API)

java.lang.Object
- com.opsmatters.bitly.api.model.v4.BitlinkQuery

```
public class BitlinkQuery
extends Object
```
Represents a query based on bitlinks.

Author:

Gerald Curley (opsmatters)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BitlinkQuery.Builder
Builder to make query construction easier.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BitlinkQuery.Builder` Builder to make query construction easier.

Constructor Summary

Constructors
Constructor and Description

BitlinkQuery()
Default constructor.

Constructors
Constructor and Description
`BitlinkQuery()` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BitlinkQuery.Builder`	`builder()` Returns a builder for the query.
`Switch`	`getArchived()` Returns whether or not to include archived bitlinks.
`String`	`getCampaignGuid()` Returns filter to return only links for the given campaign GUID.
`String`	`getChannelGuid()` Returns filter to return only links for the given channel GUID, overrides all other parameters.
`int`	`getCreatedAfter()` Returns the timestamp as an integer unix epoch.
`int`	`getCreatedBefore()` Returns the timestamp as an integer unix epoch.
`Switch`	`getCustomBitlink()` Returns whether to filter to only bitlinks that are custom bitlinks.
`Switch`	`getDeeplinks()` Returns whether to filter to only bitlinks that contain deeplinks.
`Switch`	`getDomainDeeplinks()` Returns whether to filter to only bitlinks that contain deeplinks configured with a custom domain.
`List<String>`	`getEncodingLogin()` Returns filter by the login of the authenticated user that created the bitlink.
`String`	`getKeyword()` Returns the custom keyword to filter on history entries.
`int`	`getModifiedAfter()` Returns the timestamp as an integer unix epoch.
`int`	`getPage()` Returns the start page.
`String`	`getQuery()` Returns the value that you would like to search.
`int`	`getSize()` Returns the quantity of items to be returned.
`List<String>`	`getTags()` Returns filter on the bitlink tags.
`void`	`setArchived(Switch archived)` Sets whether or not to include archived bitlinks.
`void`	`setCampaignGuid(String campaignGuid)` Sets filter to return only links for the given campaign GUID.
`void`	`setChannelGuid(String channelGuid)` Sets filter to return only links for the given channel GUID, overrides all other parameters.
`void`	`setCreatedAfter(int createdAfter)` Sets the timestamp as an integer unix epoch.
`void`	`setCreatedBefore(int createdBefore)` Sets the timestamp as an integer unix epoch.
`void`	`setCustomBitlink(Switch customBitlink)` Sets whether to filter to only bitlinks that are custom bitlinks.
`void`	`setDeeplinks(Switch deeplinks)` Sets whether to filter to only bitlinks that contain deeplinks.
`void`	`setDomainDeeplinks(Switch domainDeeplinks)` Sets whether to filter to only bitlinks that contain deeplinks configured with a custom domain.
`void`	`setEncodingLogin(List<String> encodingLogin)` Sets filter by the login of the authenticated user that created the bitlink.
`void`	`setKeyword(String keyword)` Sets the custom keyword to filter on history entries.
`void`	`setModifiedAfter(int modifiedAfter)` Sets the timestamp as an integer unix epoch.
`void`	`setPage(int page)` Sets the start page.
`void`	`setQuery(String query)` Sets the value that you would like to search.
`void`	`setSize(int size)` Sets the quantity of items to be returned.
`void`	`setTags(List<String> tags)` Sets filter on the bitlink tags.
`String`	`toString()` Returns a string representation of the object.

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

- Constructor Detail
  - BitlinkQuery
```
public BitlinkQuery()
```
    Default constructor.
- Method Detail
  - getSize
```
public int getSize()
```
    Returns the quantity of items to be returned.
    
    Returns:
    
    The size for the query
  - setSize
```
public void setSize(int size)
```
    Sets the quantity of items to be returned. Defaults to 50.
    
    Parameters:
    
    size - The size for the query
  - getPage
```
public int getPage()
```
    Returns the start page.
    
    Returns:
    
    The start page
  - setPage
```
public void setPage(int page)
```
    Sets the start page. Defaults to 1.
    
    Parameters:
    
    page - The page for the query
  - getKeyword
```
public String getKeyword()
```
    Returns the custom keyword to filter on history entries.
    
    Returns:
    
    The custom keyword
  - setKeyword
```
public void setKeyword(String keyword)
```
    Sets the custom keyword to filter on history entries.
    
    Parameters:
    
    keyword - The custom keyword
  - getQuery
```
public String getQuery()
```
    Returns the value that you would like to search.
    
    Returns:
    
    The search query
  - setQuery
```
public void setQuery(String query)
```
    Sets the value that you would like to search.
    
    Parameters:
    
    query - The search query
  - getCreatedBefore
```
public int getCreatedBefore()
```
    Returns the timestamp as an integer unix epoch.
    
    Returns:
    
    The timestamp
  - setCreatedBefore
```
public void setCreatedBefore(int createdBefore)
```
    Sets the timestamp as an integer unix epoch.
    
    Parameters:
    
    createdBefore - The timestamp
  - getCreatedAfter
```
public int getCreatedAfter()
```
    Returns the timestamp as an integer unix epoch.
    
    Returns:
    
    The timestamp
  - setCreatedAfter
```
public void setCreatedAfter(int createdAfter)
```
    Sets the timestamp as an integer unix epoch.
    
    Parameters:
    
    createdAfter - The timestamp
  - getModifiedAfter
```
public int getModifiedAfter()
```
    Returns the timestamp as an integer unix epoch.
    
    Returns:
    
    The timestamp
  - setModifiedAfter
```
public void setModifiedAfter(int modifiedAfter)
```
    Sets the timestamp as an integer unix epoch.
    
    Parameters:
    
    modifiedAfter - The timestamp
  - getArchived
```
public Switch getArchived()
```
    Returns whether or not to include archived bitlinks.
    
    Returns:
    
    Whether or not to include archived bitlinks
  - setArchived
```
public void setArchived(Switch archived)
```
    Sets whether or not to include archived bitlinks.
    
    Parameters:
    
    archived - whether or not to include archived bitlinks
  - getDeeplinks
```
public Switch getDeeplinks()
```
    Returns whether to filter to only bitlinks that contain deeplinks.
    
    Returns:
    
    Whether to filter to only bitlinks that contain deeplinks
  - setDeeplinks
```
public void setDeeplinks(Switch deeplinks)
```
    Sets whether to filter to only bitlinks that contain deeplinks.
    
    Parameters:
    
    deeplinks - whether to filter to only bitlinks that contain deeplinks
  - getDomainDeeplinks
```
public Switch getDomainDeeplinks()
```
    Returns whether to filter to only bitlinks that contain deeplinks configured with a custom domain.
    
    Returns:
    
    Whether to filter to only bitlinks that contain deeplinks configured with a custom domain
  - setDomainDeeplinks
```
public void setDomainDeeplinks(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
  - getCustomBitlink
```
public Switch getCustomBitlink()
```
    Returns whether to filter to only bitlinks that are custom bitlinks.
    
    Returns:
    
    Whether to filter to only bitlinks that are custom bitlinks
  - setCustomBitlink
```
public void setCustomBitlink(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
  - getCampaignGuid
```
public String getCampaignGuid()
```
    Returns filter to return only links for the given campaign GUID.
    
    Returns:
    
    Filter to return only links for the given campaign GUID
  - setCampaignGuid
```
public void setCampaignGuid(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
  - getChannelGuid
```
public String getChannelGuid()
```
    Returns filter to return only links for the given channel GUID, overrides all other parameters.
    
    Returns:
    
    Filter to return only links for the given channel GUID
  - setChannelGuid
```
public void setChannelGuid(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
  - getTags
```
public List<String> getTags()
```
    Returns filter on the bitlink tags.
    
    Returns:
    
    Filter on the bitlink tags
  - setTags
```
public void setTags(List<String> tags)
```
    Sets filter on the bitlink tags.
    
    Parameters:
    
    tags - Filter on the bitlink tags
  - getEncodingLogin
```
public List<String> getEncodingLogin()
```
    Returns filter by the login of the authenticated user that created the bitlink.
    
    Returns:
    
    Filter by the login of the authenticated user that created the bitlink
  - setEncodingLogin
```
public void setEncodingLogin(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
  - toString
```
public String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class Object
  - builder
```
public static BitlinkQuery.Builder builder()
```
    Returns a builder for the query.
    
    Returns:
    
    The builder instance.

Class BitlinkQuery

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BitlinkQuery

Method Detail

getSize

setSize

getPage

setPage

getKeyword

setKeyword

getQuery

setQuery

getCreatedBefore

setCreatedBefore

getCreatedAfter

setCreatedAfter

getModifiedAfter

setModifiedAfter

getArchived

setArchived

getDeeplinks

setDeeplinks

getDomainDeeplinks

setDomainDeeplinks

getCustomBitlink

setCustomBitlink

getCampaignGuid

setCampaignGuid

getChannelGuid

setChannelGuid

getTags

setTags

getEncodingLogin

setEncodingLogin

toString

builder