Class GetArtistsAlbumsRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<AlbumSimplified>, GetArtistsAlbumsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<AlbumSimplified>, GetArtistsAlbumsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<AlbumSimplified, GetArtistsAlbumsRequest.Builder>

se.michaelthelin.spotify.requests.data.artists.GetArtistsAlbumsRequest.Builder

All Implemented Interfaces:

IPagingRequestBuilder<AlbumSimplified, GetArtistsAlbumsRequest.Builder>, IRequest.Builder<Paging<AlbumSimplified>, GetArtistsAlbumsRequest.Builder>

Enclosing class:

GetArtistsAlbumsRequest

public static final class GetArtistsAlbumsRequest.Builder
extends AbstractDataPagingRequest.Builder<AlbumSimplified, GetArtistsAlbumsRequest.Builder>

Builder class for building a GetArtistsAlbumsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder(String accessToken)	Create a new GetArtistsAlbumsRequest.Builder instance.

Method Summary

Modifier and Type	Method	Description
GetArtistsAlbumsRequest.Builder	album_type(String album_type)	Deprecated. Use include_groups(String) instead.
GetArtistsAlbumsRequest	build()	The request build method.
GetArtistsAlbumsRequest.Builder	id(String id)	The artist ID setter.
GetArtistsAlbumsRequest.Builder	include_groups(String include_groups)	The include groups filter setter.
GetArtistsAlbumsRequest.Builder	limit(Integer limit)	The limit setter.
GetArtistsAlbumsRequest.Builder	market(CountryCode market)	The market filter setter.
GetArtistsAlbumsRequest.Builder	offset(Integer offset)	The offset setter.
protected GetArtistsAlbumsRequest.Builder	self()	Return this instance to simulate a self-type.

Methods inherited from class AbstractRequest.Builder

setBody, setBodyParameter, setContentType, setDefaults, setHeader, setHost, setHttpManager, setPath, setPathParameter, setPort, setQueryParameter, setScheme

Modifier and Type	Method	Description
GetArtistsAlbumsRequest.Builder	setBody(org.apache.hc.core5.http.HttpEntity httpEntity)	Set the body for the request.
<X> GetArtistsAlbumsRequest.Builder	setBodyParameter(String name, X value)	Set a body parameter for the request.
GetArtistsAlbumsRequest.Builder	setContentType(org.apache.hc.core5.http.ContentType contentType)	Set the content type for the request.
GetArtistsAlbumsRequest.Builder	setDefaults(IHttpManager httpManager, String scheme, String host, Integer port)	Set default values for the request.
<X> GetArtistsAlbumsRequest.Builder	setHeader(String name, X value)	Set a header for the request.
GetArtistsAlbumsRequest.Builder	setHost(String host)	Set the host for the request.
GetArtistsAlbumsRequest.Builder	setHttpManager(IHttpManager httpManager)	Set the HTTP manager for the request.
GetArtistsAlbumsRequest.Builder	setPath(String path)	Set the path for the request.
GetArtistsAlbumsRequest.Builder	setPathParameter(String name, String value)	Set a path parameter for the request.
GetArtistsAlbumsRequest.Builder	setPort(Integer port)	Set the port for the request.
<X> GetArtistsAlbumsRequest.Builder	setQueryParameter(String name, X value)	Set a query parameter for the request.
GetArtistsAlbumsRequest.Builder	setScheme(String scheme)	Set the scheme for the request.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new GetArtistsAlbumsRequest.Builder instance.

Parameters:

accessToken - Required. A valid access token from the Spotify Accounts service.

Method Details

id

public GetArtistsAlbumsRequest.Builder id(String id)

The artist ID setter.

Parameters:

id - The Spotify ID for the artist.

Returns:

A GetArtistsAlbumsRequest.Builder.

See Also:

• Spotify URIs & IDs

album_type

@Deprecated
public GetArtistsAlbumsRequest.Builder album_type(String album_type)

Deprecated.

Use include_groups(String) instead.

The album type filter setter.

Parameters:

album_type - Optional. A comma-separated list of keywords that will be used to filter the response. If not supplied, all album types will be returned. Valid values are: album, single, appears_on and compilation.

Returns:

A GetArtistsAlbumsRequest.Builder.

include_groups

public GetArtistsAlbumsRequest.Builder include_groups(String include_groups)

The include groups filter setter.

Parameters:

include_groups - Optional. A comma-separated list of keywords that will be used to filter the response. If not supplied, all album types will be returned. Valid values are: album, single, appears_on and compilation.

Returns:

A GetArtistsAlbumsRequest.Builder.

See Also:

• Spotify Web API References / Get Artist's Albums

market

public GetArtistsAlbumsRequest.Builder market(CountryCode market)

The market filter setter.

Parameters:

market - Optional. An ISO 3166-1 alpha-2 country code. Supply this parameter to limit the response to one particular geographical market.

Returns:

A GetArtistsAlbumsRequest.Builder.

See Also:

• Wikipedia: ISO 3166-1 alpha-2 country codes

limit

public GetArtistsAlbumsRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

limit - Optional. The number of album objects to return. Default: 20. Minimum: 1. Maximum: 50.

Returns:

A GetArtistsAlbumsRequest.Builder.

offset

public GetArtistsAlbumsRequest.Builder offset(Integer offset)

The offset setter.

Parameters:

offset - Optional. The index of the first album to return. Default: 0 (i.e., the first album). Use with limit(Integer) to get the next set of albums.

Returns:

A GetArtistsAlbumsRequest.Builder.

build

public GetArtistsAlbumsRequest build()

The request build method.

Returns:

A custom GetArtistsAlbumsRequest.

self

protected GetArtistsAlbumsRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<AlbumSimplified>, GetArtistsAlbumsRequest.Builder>

Returns:

This instance.