Package com.launchdarkly.api.api

Class InsightsPullRequestsBetaApi

java.lang.Object

com.launchdarkly.api.api.InsightsPullRequestsBetaApi

public class InsightsPullRequestsBetaApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
InsightsPullRequestsBetaApi()
InsightsPullRequestsBetaApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
PullRequestCollectionRep	getPullRequests(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String applicationKey, java.lang.String status, java.lang.String query, java.lang.Long limit, java.lang.String expand, java.lang.String sort, java.time.OffsetDateTime from, java.time.OffsetDateTime to, java.lang.String after, java.lang.String before)	List pull requests Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields.
okhttp3.Call	getPullRequestsAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String applicationKey, java.lang.String status, java.lang.String query, java.lang.Long limit, java.lang.String expand, java.lang.String sort, java.time.OffsetDateTime from, java.time.OffsetDateTime to, java.lang.String after, java.lang.String before, ApiCallback<PullRequestCollectionRep> _callback)	List pull requests (asynchronously) Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields.
okhttp3.Call	getPullRequestsCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String applicationKey, java.lang.String status, java.lang.String query, java.lang.Long limit, java.lang.String expand, java.lang.String sort, java.time.OffsetDateTime from, java.time.OffsetDateTime to, java.lang.String after, java.lang.String before, ApiCallback _callback)	Build call for getPullRequests
ApiResponse<PullRequestCollectionRep>	getPullRequestsWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String applicationKey, java.lang.String status, java.lang.String query, java.lang.Long limit, java.lang.String expand, java.lang.String sort, java.time.OffsetDateTime from, java.time.OffsetDateTime to, java.lang.String after, java.lang.String before)	List pull requests Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

InsightsPullRequestsBetaApi

public InsightsPullRequestsBetaApi()

InsightsPullRequestsBetaApi

public InsightsPullRequestsBetaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

getPullRequestsCall

public okhttp3.Call getPullRequestsCall(java.lang.String projectKey,
                                        java.lang.String environmentKey,
                                        java.lang.String applicationKey,
                                        java.lang.String status,
                                        java.lang.String query,
                                        java.lang.Long limit,
                                        java.lang.String expand,
                                        java.lang.String sort,
                                        java.time.OffsetDateTime from,
                                        java.time.OffsetDateTime to,
                                        java.lang.String after,
                                        java.lang.String before,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getPullRequests

Parameters:

projectKey - The project key (required)

environmentKey - Required if you are using the <code>sort</code> parameter's <code>leadTime</code> option to sort pull requests. (optional)

applicationKey - Filter the results to pull requests deployed to a comma separated list of applications (optional)

status - Filter results to pull requests with the given status. Options: `open`, `merged`, `closed`, `deployed`. (optional)

query - Filter list of pull requests by title or author (optional)

limit - The number of pull requests to return. Default is 20. Maximum allowed is 100. (optional)

expand - Expand properties in response. Options: `deployments`, `flagReferences`, `leadTime`. (optional)

sort - Sort results. Requires the `environmentKey` to be set. Options: `leadTime` (asc) and `-leadTime` (desc). When query option is excluded, default sort is by created or merged date. (optional)

from - Unix timestamp in milliseconds. Default value is 7 days ago. (optional)

to - Unix timestamp in milliseconds. Default value is now. (optional)

after - Identifier used for pagination (optional)

before - Identifier used for pagination (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPullRequests

public PullRequestCollectionRep getPullRequests(java.lang.String projectKey,
                                                java.lang.String environmentKey,
                                                java.lang.String applicationKey,
                                                java.lang.String status,
                                                java.lang.String query,
                                                java.lang.Long limit,
                                                java.lang.String expand,
                                                java.lang.String sort,
                                                java.time.OffsetDateTime from,
                                                java.time.OffsetDateTime to,
                                                java.lang.String after,
                                                java.lang.String before)
                                         throws ApiException

List pull requests Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `deployments` includes details on all of the deployments associated with each pull request * `flagReferences` includes details on all of the references to flags in each pull request * `leadTime` includes details about the lead time of the pull request for each stage For example, use `?expand=deployments` to include the `deployments` field in the response. By default, this field is **not** included in the response.

Parameters:

projectKey - The project key (required)

environmentKey - Required if you are using the <code>sort</code> parameter's <code>leadTime</code> option to sort pull requests. (optional)

applicationKey - Filter the results to pull requests deployed to a comma separated list of applications (optional)

status - Filter results to pull requests with the given status. Options: `open`, `merged`, `closed`, `deployed`. (optional)

query - Filter list of pull requests by title or author (optional)

limit - The number of pull requests to return. Default is 20. Maximum allowed is 100. (optional)

expand - Expand properties in response. Options: `deployments`, `flagReferences`, `leadTime`. (optional)

sort - Sort results. Requires the `environmentKey` to be set. Options: `leadTime` (asc) and `-leadTime` (desc). When query option is excluded, default sort is by created or merged date. (optional)

from - Unix timestamp in milliseconds. Default value is 7 days ago. (optional)

to - Unix timestamp in milliseconds. Default value is now. (optional)

after - Identifier used for pagination (optional)

before - Identifier used for pagination (optional)

Returns:

PullRequestCollectionRep

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPullRequestsWithHttpInfo

public ApiResponse<PullRequestCollectionRep> getPullRequestsWithHttpInfo(java.lang.String projectKey,
                                                                         java.lang.String environmentKey,
                                                                         java.lang.String applicationKey,
                                                                         java.lang.String status,
                                                                         java.lang.String query,
                                                                         java.lang.Long limit,
                                                                         java.lang.String expand,
                                                                         java.lang.String sort,
                                                                         java.time.OffsetDateTime from,
                                                                         java.time.OffsetDateTime to,
                                                                         java.lang.String after,
                                                                         java.lang.String before)
                                                                  throws ApiException

List pull requests Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `deployments` includes details on all of the deployments associated with each pull request * `flagReferences` includes details on all of the references to flags in each pull request * `leadTime` includes details about the lead time of the pull request for each stage For example, use `?expand=deployments` to include the `deployments` field in the response. By default, this field is **not** included in the response.

Parameters:

projectKey - The project key (required)

environmentKey - Required if you are using the <code>sort</code> parameter's <code>leadTime</code> option to sort pull requests. (optional)

applicationKey - Filter the results to pull requests deployed to a comma separated list of applications (optional)

status - Filter results to pull requests with the given status. Options: `open`, `merged`, `closed`, `deployed`. (optional)

query - Filter list of pull requests by title or author (optional)

limit - The number of pull requests to return. Default is 20. Maximum allowed is 100. (optional)

expand - Expand properties in response. Options: `deployments`, `flagReferences`, `leadTime`. (optional)

sort - Sort results. Requires the `environmentKey` to be set. Options: `leadTime` (asc) and `-leadTime` (desc). When query option is excluded, default sort is by created or merged date. (optional)

from - Unix timestamp in milliseconds. Default value is 7 days ago. (optional)

to - Unix timestamp in milliseconds. Default value is now. (optional)

after - Identifier used for pagination (optional)

before - Identifier used for pagination (optional)

Returns:

ApiResponse<PullRequestCollectionRep>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPullRequestsAsync

public okhttp3.Call getPullRequestsAsync(java.lang.String projectKey,
                                         java.lang.String environmentKey,
                                         java.lang.String applicationKey,
                                         java.lang.String status,
                                         java.lang.String query,
                                         java.lang.Long limit,
                                         java.lang.String expand,
                                         java.lang.String sort,
                                         java.time.OffsetDateTime from,
                                         java.time.OffsetDateTime to,
                                         java.lang.String after,
                                         java.lang.String before,
                                         ApiCallback<PullRequestCollectionRep> _callback)
                                  throws ApiException

List pull requests (asynchronously) Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `deployments` includes details on all of the deployments associated with each pull request * `flagReferences` includes details on all of the references to flags in each pull request * `leadTime` includes details about the lead time of the pull request for each stage For example, use `?expand=deployments` to include the `deployments` field in the response. By default, this field is **not** included in the response.

Parameters:

projectKey - The project key (required)

environmentKey - Required if you are using the <code>sort</code> parameter's <code>leadTime</code> option to sort pull requests. (optional)

applicationKey - Filter the results to pull requests deployed to a comma separated list of applications (optional)

status - Filter results to pull requests with the given status. Options: `open`, `merged`, `closed`, `deployed`. (optional)

query - Filter list of pull requests by title or author (optional)

limit - The number of pull requests to return. Default is 20. Maximum allowed is 100. (optional)

expand - Expand properties in response. Options: `deployments`, `flagReferences`, `leadTime`. (optional)

sort - Sort results. Requires the `environmentKey` to be set. Options: `leadTime` (asc) and `-leadTime` (desc). When query option is excluded, default sort is by created or merged date. (optional)

from - Unix timestamp in milliseconds. Default value is 7 days ago. (optional)

to - Unix timestamp in milliseconds. Default value is now. (optional)

after - Identifier used for pagination (optional)

before - Identifier used for pagination (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object