Package org.sourcelab.buildkite.api.client.request

Class ListOrganizationsRequest

java.lang.Object

org.sourcelab.buildkite.api.client.request.GetRequest<ListOrganizationsResponse>

org.sourcelab.buildkite.api.client.request.ListOrganizationsRequest

All Implemented Interfaces:

PageableRequest<ListOrganizationsResponse>, Request<ListOrganizationsResponse>

public class ListOrganizationsRequest
extends GetRequest<ListOrganizationsResponse>
implements PageableRequest<ListOrganizationsResponse>

Constructor Summary

Constructors

Constructor	Description
ListOrganizationsRequest(OrganizationFilters filters)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getPath()	REST Endpoint Path to request.
RequestParameters	getRequestParameters()	KeyValue pairs of Request Parameters.
ResponseParser<ListOrganizationsResponse>	getResponseParser()	Defines how to parse the APIs response into a concrete object.
void	updatePageOptions(PageOptions pageOptions)

Methods inherited from class org.sourcelab.buildkite.api.client.request.GetRequest

getMethod

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sourcelab.buildkite.api.client.request.Request

getMethod, getRequestBody, parseResponse

Constructor Details

ListOrganizationsRequest

public ListOrganizationsRequest(OrganizationFilters filters)

Constructor.

Parameters:

filters - Search Criteria.

Method Details

getPath

public String getPath()

Description copied from interface: Request

REST Endpoint Path to request. Example "/v2/access-token"

Specified by:

getPath in interface Request<ListOrganizationsResponse>

Returns:

REST Endpoint Path to request. Example "/v2/access-token"

getRequestParameters

public RequestParameters getRequestParameters()

Description copied from interface: Request

KeyValue pairs of Request Parameters.

Specified by:

getRequestParameters in interface Request<ListOrganizationsResponse>

Returns:

RequestParameters associated with request.

getResponseParser

public ResponseParser<ListOrganizationsResponse> getResponseParser()

Description copied from interface: Request

Defines how to parse the APIs response into a concrete object.

Specified by:

getResponseParser in interface Request<ListOrganizationsResponse>

Returns:

Defines how to parse the APIs response into a concrete object.

updatePageOptions

public void updatePageOptions(PageOptions pageOptions)

Specified by:

updatePageOptions in interface PageableRequest<ListOrganizationsResponse>