Package com.launchdarkly.api.api

Class DataExportDestinationsApi

  • public class DataExportDestinationsApi
extends java.lang.Object

    • Constructor Detail

      • DataExportDestinationsApi

        public DataExportDestinationsApi()

      • DataExportDestinationsApi

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

      • deleteDestinationCall

        public okhttp3.Call deleteDestinationCall​(java.lang.String projectKey,
                                          java.lang.String environmentKey,
                                          java.lang.String id,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for deleteDestination
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteDestination

        public void deleteDestination​(java.lang.String projectKey,
                              java.lang.String environmentKey,
                              java.lang.String id)
                       throws ApiException
        Delete Data Export destination Delete a Data Export destination by ID.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteDestinationWithHttpInfo

        public ApiResponse<java.lang.Void> deleteDestinationWithHttpInfo​(java.lang.String projectKey,
                                                                 java.lang.String environmentKey,
                                                                 java.lang.String id)
                                                          throws ApiException
        Delete Data Export destination Delete a Data Export destination by ID.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteDestinationAsync

        public okhttp3.Call deleteDestinationAsync​(java.lang.String projectKey,
                                           java.lang.String environmentKey,
                                           java.lang.String id,
                                           ApiCallback<java.lang.Void> _callback)
                                    throws ApiException
        Delete Data Export destination (asynchronously) Delete a Data Export destination by ID.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (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

      • getDestinationCall

        public okhttp3.Call getDestinationCall​(java.lang.String projectKey,
                                       java.lang.String environmentKey,
                                       java.lang.String id,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getDestination
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getDestination

        public Destination getDestination​(java.lang.String projectKey,
                                  java.lang.String environmentKey,
                                  java.lang.String id)
                           throws ApiException
        Get destination Get a single Data Export destination by ID.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (required)
        Returns:
        Destination
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDestinationWithHttpInfo

        public ApiResponse<Destination> getDestinationWithHttpInfo​(java.lang.String projectKey,
                                                           java.lang.String environmentKey,
                                                           java.lang.String id)
                                                    throws ApiException
        Get destination Get a single Data Export destination by ID.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (required)
        Returns:
        ApiResponse<Destination>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDestinationAsync

        public okhttp3.Call getDestinationAsync​(java.lang.String projectKey,
                                        java.lang.String environmentKey,
                                        java.lang.String id,
                                        ApiCallback<Destination> _callback)
                                 throws ApiException
        Get destination (asynchronously) Get a single Data Export destination by ID.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (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

      • getDestinationsCall

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

      • getDestinations

        public Destinations getDestinations()
                             throws ApiException
        List destinations Get a list of Data Export destinations configured across all projects and environments.
        Returns:
        Destinations
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDestinationsWithHttpInfo

        public ApiResponse<Destinations> getDestinationsWithHttpInfo()
                                                      throws ApiException
        List destinations Get a list of Data Export destinations configured across all projects and environments.
        Returns:
        ApiResponse<Destinations>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDestinationsAsync

        public okhttp3.Call getDestinationsAsync​(ApiCallback<Destinations> _callback)
                                  throws ApiException
        List destinations (asynchronously) Get a list of Data Export destinations configured across all projects and environments.
        Parameters:
        _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

      • patchDestinationCall

        public okhttp3.Call patchDestinationCall​(java.lang.String projectKey,
                                         java.lang.String environmentKey,
                                         java.lang.String id,
                                         java.util.List<PatchOperation> patchOperation,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for patchDestination
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (required)
        patchOperation - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • patchDestination

        public Destination patchDestination​(java.lang.String projectKey,
                                    java.lang.String environmentKey,
                                    java.lang.String id,
                                    java.util.List<PatchOperation> patchOperation)
                             throws ApiException
        Update Data Export destination Update a Data Export destination. Updating a destination uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (required)
        patchOperation - (required)
        Returns:
        Destination
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchDestinationWithHttpInfo

        public ApiResponse<Destination> patchDestinationWithHttpInfo​(java.lang.String projectKey,
                                                             java.lang.String environmentKey,
                                                             java.lang.String id,
                                                             java.util.List<PatchOperation> patchOperation)
                                                      throws ApiException
        Update Data Export destination Update a Data Export destination. Updating a destination uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination ID (required)
        patchOperation - (required)
        Returns:
        ApiResponse<Destination>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchDestinationAsync

        public okhttp3.Call patchDestinationAsync​(java.lang.String projectKey,
                                          java.lang.String environmentKey,
                                          java.lang.String id,
                                          java.util.List<PatchOperation> patchOperation,
                                          ApiCallback<Destination> _callback)
                                   throws ApiException
        Update Data Export destination (asynchronously) Update a Data Export destination. Updating a destination uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        id - The Data Export destination 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

      • postDestinationCall

        public okhttp3.Call postDestinationCall​(java.lang.String projectKey,
                                        java.lang.String environmentKey,
                                        DestinationPost destinationPost,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for postDestination
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        destinationPost - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postDestination

        public Destination postDestination​(java.lang.String projectKey,
                                   java.lang.String environmentKey,
                                   DestinationPost destinationPost)
                            throws ApiException
        Create Data Export destination Create a new Data Export destination. In the `config` request body parameter, the fields required depend on the type of Data Export destination. <details> <summary>Click to expand <code>config</code> parameter details</summary> #### Azure Event Hubs To create a Data Export destination with a `kind` of `azure-event-hubs`, the `config` object requires the following fields: * `namespace`: The Event Hub Namespace name * `name`: The Event Hub name * `policyName`: The shared access signature policy name. You can find your policy name in the settings of your Azure Event Hubs Namespace. * `policyKey`: The shared access signature key. You can find your policy key in the settings of your Azure Event Hubs Namespace. #### Google Cloud Pub/Sub To create a Data Export destination with a `kind` of `google-pubsub`, the `config` object requires the following fields: * `project`: The Google PubSub project ID for the project to publish to * `topic`: The Google PubSub topic ID for the topic to publish to #### Amazon Kinesis To create a Data Export destination with a `kind` of `kinesis`, the `config` object requires the following fields: * `region`: The Kinesis stream's AWS region key * `roleArn`: The Amazon Resource Name (ARN) of the AWS role that will be writing to Kinesis * `streamName`: The name of the Kinesis stream that LaunchDarkly is sending events to. This is not the ARN of the stream. #### mParticle To create a Data Export destination with a `kind` of `mparticle`, the `config` object requires the following fields: * `apiKey`: The mParticle API key * `secret`: The mParticle API secret * `userIdentity`: The type of identifier you use to identify your end users in mParticle * `anonymousUserIdentity`: The type of identifier you use to identify your anonymous end users in mParticle #### Segment To create a Data Export destination with a `kind` of `segment`, the `config` object requires the following fields: * `writeKey`: The Segment write key. This is used to authenticate LaunchDarkly's calls to Segment. </details>
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        destinationPost - (required)
        Returns:
        Destination
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postDestinationWithHttpInfo

        public ApiResponse<Destination> postDestinationWithHttpInfo​(java.lang.String projectKey,
                                                            java.lang.String environmentKey,
                                                            DestinationPost destinationPost)
                                                     throws ApiException
        Create Data Export destination Create a new Data Export destination. In the `config` request body parameter, the fields required depend on the type of Data Export destination. <details> <summary>Click to expand <code>config</code> parameter details</summary> #### Azure Event Hubs To create a Data Export destination with a `kind` of `azure-event-hubs`, the `config` object requires the following fields: * `namespace`: The Event Hub Namespace name * `name`: The Event Hub name * `policyName`: The shared access signature policy name. You can find your policy name in the settings of your Azure Event Hubs Namespace. * `policyKey`: The shared access signature key. You can find your policy key in the settings of your Azure Event Hubs Namespace. #### Google Cloud Pub/Sub To create a Data Export destination with a `kind` of `google-pubsub`, the `config` object requires the following fields: * `project`: The Google PubSub project ID for the project to publish to * `topic`: The Google PubSub topic ID for the topic to publish to #### Amazon Kinesis To create a Data Export destination with a `kind` of `kinesis`, the `config` object requires the following fields: * `region`: The Kinesis stream's AWS region key * `roleArn`: The Amazon Resource Name (ARN) of the AWS role that will be writing to Kinesis * `streamName`: The name of the Kinesis stream that LaunchDarkly is sending events to. This is not the ARN of the stream. #### mParticle To create a Data Export destination with a `kind` of `mparticle`, the `config` object requires the following fields: * `apiKey`: The mParticle API key * `secret`: The mParticle API secret * `userIdentity`: The type of identifier you use to identify your end users in mParticle * `anonymousUserIdentity`: The type of identifier you use to identify your anonymous end users in mParticle #### Segment To create a Data Export destination with a `kind` of `segment`, the `config` object requires the following fields: * `writeKey`: The Segment write key. This is used to authenticate LaunchDarkly's calls to Segment. </details>
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        destinationPost - (required)
        Returns:
        ApiResponse<Destination>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postDestinationAsync

        public okhttp3.Call postDestinationAsync​(java.lang.String projectKey,
                                         java.lang.String environmentKey,
                                         DestinationPost destinationPost,
                                         ApiCallback<Destination> _callback)
                                  throws ApiException
        Create Data Export destination (asynchronously) Create a new Data Export destination. In the `config` request body parameter, the fields required depend on the type of Data Export destination. <details> <summary>Click to expand <code>config</code> parameter details</summary> #### Azure Event Hubs To create a Data Export destination with a `kind` of `azure-event-hubs`, the `config` object requires the following fields: * `namespace`: The Event Hub Namespace name * `name`: The Event Hub name * `policyName`: The shared access signature policy name. You can find your policy name in the settings of your Azure Event Hubs Namespace. * `policyKey`: The shared access signature key. You can find your policy key in the settings of your Azure Event Hubs Namespace. #### Google Cloud Pub/Sub To create a Data Export destination with a `kind` of `google-pubsub`, the `config` object requires the following fields: * `project`: The Google PubSub project ID for the project to publish to * `topic`: The Google PubSub topic ID for the topic to publish to #### Amazon Kinesis To create a Data Export destination with a `kind` of `kinesis`, the `config` object requires the following fields: * `region`: The Kinesis stream's AWS region key * `roleArn`: The Amazon Resource Name (ARN) of the AWS role that will be writing to Kinesis * `streamName`: The name of the Kinesis stream that LaunchDarkly is sending events to. This is not the ARN of the stream. #### mParticle To create a Data Export destination with a `kind` of `mparticle`, the `config` object requires the following fields: * `apiKey`: The mParticle API key * `secret`: The mParticle API secret * `userIdentity`: The type of identifier you use to identify your end users in mParticle * `anonymousUserIdentity`: The type of identifier you use to identify your anonymous end users in mParticle #### Segment To create a Data Export destination with a `kind` of `segment`, the `config` object requires the following fields: * `writeKey`: The Segment write key. This is used to authenticate LaunchDarkly's calls to Segment. </details>
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        destinationPost - (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