Package com.launchdarkly.api.api

Class InsightsDeploymentsBetaApi

  • public class InsightsDeploymentsBetaApi
extends java.lang.Object

    • Constructor Detail

      • InsightsDeploymentsBetaApi

        public InsightsDeploymentsBetaApi()

      • InsightsDeploymentsBetaApi

        public InsightsDeploymentsBetaApi​(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)

      • createDeploymentEventCall

        public okhttp3.Call createDeploymentEventCall​(PostDeploymentEventInput postDeploymentEventInput,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for createDeploymentEvent
        Parameters:
        postDeploymentEventInput - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createDeploymentEvent

        public void createDeploymentEvent​(PostDeploymentEventInput postDeploymentEventInput)
                           throws ApiException
        Create deployment event Create deployment event
        Parameters:
        postDeploymentEventInput - (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createDeploymentEventWithHttpInfo

        public ApiResponse<java.lang.Void> createDeploymentEventWithHttpInfo​(PostDeploymentEventInput postDeploymentEventInput)
                                                              throws ApiException
        Create deployment event Create deployment event
        Parameters:
        postDeploymentEventInput - (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createDeploymentEventAsync

        public okhttp3.Call createDeploymentEventAsync​(PostDeploymentEventInput postDeploymentEventInput,
                                               ApiCallback<java.lang.Void> _callback)
                                        throws ApiException
        Create deployment event (asynchronously) Create deployment event
        Parameters:
        postDeploymentEventInput - (required)
        _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

      • getDeploymentCall

        public okhttp3.Call getDeploymentCall​(java.lang.String deploymentID,
                                      java.lang.String expand,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getDeployment
        Parameters:
        deploymentID - The deployment ID (required)
        expand - Expand properties in response. Options: `pullRequests`, `flagReferences` (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getDeployment

        public DeploymentRep getDeployment​(java.lang.String deploymentID,
                                   java.lang.String expand)
                            throws ApiException
        Get deployment Get a deployment by ID. The deployment ID is returned as part of the [List deployments](#operation/getDeployments) response. It is the `id` field of each element in the `items` array. ### Expanding the deployment response LaunchDarkly supports expanding the deployment response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response.
        Parameters:
        deploymentID - The deployment ID (required)
        expand - Expand properties in response. Options: `pullRequests`, `flagReferences` (optional)
        Returns:
        DeploymentRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentWithHttpInfo

        public ApiResponse<DeploymentRep> getDeploymentWithHttpInfo​(java.lang.String deploymentID,
                                                            java.lang.String expand)
                                                     throws ApiException
        Get deployment Get a deployment by ID. The deployment ID is returned as part of the [List deployments](#operation/getDeployments) response. It is the `id` field of each element in the `items` array. ### Expanding the deployment response LaunchDarkly supports expanding the deployment response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response.
        Parameters:
        deploymentID - The deployment ID (required)
        expand - Expand properties in response. Options: `pullRequests`, `flagReferences` (optional)
        Returns:
        ApiResponse<DeploymentRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentAsync

        public okhttp3.Call getDeploymentAsync​(java.lang.String deploymentID,
                                       java.lang.String expand,
                                       ApiCallback<DeploymentRep> _callback)
                                throws ApiException
        Get deployment (asynchronously) Get a deployment by ID. The deployment ID is returned as part of the [List deployments](#operation/getDeployments) response. It is the `id` field of each element in the `items` array. ### Expanding the deployment response LaunchDarkly supports expanding the deployment response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response.
        Parameters:
        deploymentID - The deployment ID (required)
        expand - Expand properties in response. Options: `pullRequests`, `flagReferences` (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

      • getDeploymentsCall

        public okhttp3.Call getDeploymentsCall​(java.lang.String projectKey,
                                       java.lang.String environmentKey,
                                       java.lang.String applicationKey,
                                       java.lang.Long limit,
                                       java.lang.String expand,
                                       java.lang.Long from,
                                       java.lang.Long to,
                                       java.lang.String after,
                                       java.lang.String before,
                                       java.lang.String kind,
                                       java.lang.String status,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getDeployments
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        limit - The number of deployments to return. Default is 20. Maximum allowed is 100. (optional)
        expand - Expand properties in response. Options: `pullRequests`, `flagReferences` (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)
        kind - The deployment kind (optional)
        status - The deployment status (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getDeployments

        public DeploymentCollectionRep getDeployments​(java.lang.String projectKey,
                                              java.lang.String environmentKey,
                                              java.lang.String applicationKey,
                                              java.lang.Long limit,
                                              java.lang.String expand,
                                              java.lang.Long from,
                                              java.lang.Long to,
                                              java.lang.String after,
                                              java.lang.String before,
                                              java.lang.String kind,
                                              java.lang.String status)
                                       throws ApiException
        List deployments Get a list of deployments ### Expanding the deployment collection response LaunchDarkly supports expanding the deployment collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        limit - The number of deployments to return. Default is 20. Maximum allowed is 100. (optional)
        expand - Expand properties in response. Options: `pullRequests`, `flagReferences` (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)
        kind - The deployment kind (optional)
        status - The deployment status (optional)
        Returns:
        DeploymentCollectionRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentsWithHttpInfo

        public ApiResponse<DeploymentCollectionRep> getDeploymentsWithHttpInfo​(java.lang.String projectKey,
                                                                       java.lang.String environmentKey,
                                                                       java.lang.String applicationKey,
                                                                       java.lang.Long limit,
                                                                       java.lang.String expand,
                                                                       java.lang.Long from,
                                                                       java.lang.Long to,
                                                                       java.lang.String after,
                                                                       java.lang.String before,
                                                                       java.lang.String kind,
                                                                       java.lang.String status)
                                                                throws ApiException
        List deployments Get a list of deployments ### Expanding the deployment collection response LaunchDarkly supports expanding the deployment collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        limit - The number of deployments to return. Default is 20. Maximum allowed is 100. (optional)
        expand - Expand properties in response. Options: `pullRequests`, `flagReferences` (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)
        kind - The deployment kind (optional)
        status - The deployment status (optional)
        Returns:
        ApiResponse<DeploymentCollectionRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentsAsync

        public okhttp3.Call getDeploymentsAsync​(java.lang.String projectKey,
                                        java.lang.String environmentKey,
                                        java.lang.String applicationKey,
                                        java.lang.Long limit,
                                        java.lang.String expand,
                                        java.lang.Long from,
                                        java.lang.Long to,
                                        java.lang.String after,
                                        java.lang.String before,
                                        java.lang.String kind,
                                        java.lang.String status,
                                        ApiCallback<DeploymentCollectionRep> _callback)
                                 throws ApiException
        List deployments (asynchronously) Get a list of deployments ### Expanding the deployment collection response LaunchDarkly supports expanding the deployment collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        limit - The number of deployments to return. Default is 20. Maximum allowed is 100. (optional)
        expand - Expand properties in response. Options: `pullRequests`, `flagReferences` (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)
        kind - The deployment kind (optional)
        status - The deployment status (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

      • updateDeploymentCall

        public okhttp3.Call updateDeploymentCall​(java.lang.String deploymentID,
                                         java.util.List<PatchOperation> patchOperation,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for updateDeployment
        Parameters:
        deploymentID - The deployment ID (required)
        patchOperation - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateDeployment

        public DeploymentRep updateDeployment​(java.lang.String deploymentID,
                                      java.util.List<PatchOperation> patchOperation)
                               throws ApiException
        Update deployment Update a deployment by ID. Updating a deployment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).<br/><br/>The deployment ID is returned as part of the [List deployments](#operation/getDeployments) response. It is the `id` field of each element in the `items` array.
        Parameters:
        deploymentID - The deployment ID (required)
        patchOperation - (required)
        Returns:
        DeploymentRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateDeploymentWithHttpInfo

        public ApiResponse<DeploymentRep> updateDeploymentWithHttpInfo​(java.lang.String deploymentID,
                                                               java.util.List<PatchOperation> patchOperation)
                                                        throws ApiException
        Update deployment Update a deployment by ID. Updating a deployment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).<br/><br/>The deployment ID is returned as part of the [List deployments](#operation/getDeployments) response. It is the `id` field of each element in the `items` array.
        Parameters:
        deploymentID - The deployment ID (required)
        patchOperation - (required)
        Returns:
        ApiResponse<DeploymentRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateDeploymentAsync

        public okhttp3.Call updateDeploymentAsync​(java.lang.String deploymentID,
                                          java.util.List<PatchOperation> patchOperation,
                                          ApiCallback<DeploymentRep> _callback)
                                   throws ApiException
        Update deployment (asynchronously) Update a deployment by ID. Updating a deployment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).<br/><br/>The deployment ID is returned as part of the [List deployments](#operation/getDeployments) response. It is the `id` field of each element in the `items` array.
        Parameters:
        deploymentID - The deployment ID (required)
        patchOperation - (required)
        _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