Class RelayProxyConfigurationsApi


  • public class RelayProxyConfigurationsApi
    extends java.lang.Object
    • Constructor Detail

      • RelayProxyConfigurationsApi

        public RelayProxyConfigurationsApi()
      • RelayProxyConfigurationsApi

        public RelayProxyConfigurationsApi​(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)
      • deleteRelayAutoConfigCall

        public okhttp3.Call deleteRelayAutoConfigCall​(java.lang.String id,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for deleteRelayAutoConfig
        Parameters:
        id - The relay auto config id (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • deleteRelayAutoConfig

        public void deleteRelayAutoConfig​(java.lang.String id)
                                   throws ApiException
        Delete Relay Proxy config by ID Delete a Relay Proxy config.
        Parameters:
        id - The relay auto config id (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • deleteRelayAutoConfigWithHttpInfo

        public ApiResponse<java.lang.Void> deleteRelayAutoConfigWithHttpInfo​(java.lang.String id)
                                                                      throws ApiException
        Delete Relay Proxy config by ID Delete a Relay Proxy config.
        Parameters:
        id - The relay auto config id (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • deleteRelayAutoConfigAsync

        public okhttp3.Call deleteRelayAutoConfigAsync​(java.lang.String id,
                                                       ApiCallback<java.lang.Void> _callback)
                                                throws ApiException
        Delete Relay Proxy config by ID (asynchronously) Delete a Relay Proxy config.
        Parameters:
        id - The relay auto config 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
      • getRelayProxyConfigCall

        public okhttp3.Call getRelayProxyConfigCall​(java.lang.String id,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for getRelayProxyConfig
        Parameters:
        id - The relay auto config id (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getRelayProxyConfig

        public RelayAutoConfigRep getRelayProxyConfig​(java.lang.String id)
                                               throws ApiException
        Get Relay Proxy config Get a single Relay Proxy auto config by ID.
        Parameters:
        id - The relay auto config id (required)
        Returns:
        RelayAutoConfigRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getRelayProxyConfigWithHttpInfo

        public ApiResponse<RelayAutoConfigRep> getRelayProxyConfigWithHttpInfo​(java.lang.String id)
                                                                        throws ApiException
        Get Relay Proxy config Get a single Relay Proxy auto config by ID.
        Parameters:
        id - The relay auto config id (required)
        Returns:
        ApiResponse<RelayAutoConfigRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getRelayProxyConfigAsync

        public okhttp3.Call getRelayProxyConfigAsync​(java.lang.String id,
                                                     ApiCallback<RelayAutoConfigRep> _callback)
                                              throws ApiException
        Get Relay Proxy config (asynchronously) Get a single Relay Proxy auto config by ID.
        Parameters:
        id - The relay auto config 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
      • getRelayProxyConfigsCall

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

        public RelayAutoConfigCollectionRep getRelayProxyConfigs()
                                                          throws ApiException
        List Relay Proxy configs Get a list of Relay Proxy configurations in the account.
        Returns:
        RelayAutoConfigCollectionRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getRelayProxyConfigsWithHttpInfo

        public ApiResponse<RelayAutoConfigCollectionRep> getRelayProxyConfigsWithHttpInfo()
                                                                                   throws ApiException
        List Relay Proxy configs Get a list of Relay Proxy configurations in the account.
        Returns:
        ApiResponse<RelayAutoConfigCollectionRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getRelayProxyConfigsAsync

        public okhttp3.Call getRelayProxyConfigsAsync​(ApiCallback<RelayAutoConfigCollectionRep> _callback)
                                               throws ApiException
        List Relay Proxy configs (asynchronously) Get a list of Relay Proxy configurations in the account.
        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
      • patchRelayAutoConfigCall

        public okhttp3.Call patchRelayAutoConfigCall​(java.lang.String id,
                                                     PatchWithComment patchWithComment,
                                                     ApiCallback _callback)
                                              throws ApiException
        Build call for patchRelayAutoConfig
        Parameters:
        id - The relay auto config id (required)
        patchWithComment - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • patchRelayAutoConfig

        public RelayAutoConfigRep patchRelayAutoConfig​(java.lang.String id,
                                                       PatchWithComment patchWithComment)
                                                throws ApiException
        Update a Relay Proxy config Update a Relay Proxy configuration. Updating a configuration 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:
        id - The relay auto config id (required)
        patchWithComment - (required)
        Returns:
        RelayAutoConfigRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • patchRelayAutoConfigWithHttpInfo

        public ApiResponse<RelayAutoConfigRep> patchRelayAutoConfigWithHttpInfo​(java.lang.String id,
                                                                                PatchWithComment patchWithComment)
                                                                         throws ApiException
        Update a Relay Proxy config Update a Relay Proxy configuration. Updating a configuration 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:
        id - The relay auto config id (required)
        patchWithComment - (required)
        Returns:
        ApiResponse<RelayAutoConfigRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • patchRelayAutoConfigAsync

        public okhttp3.Call patchRelayAutoConfigAsync​(java.lang.String id,
                                                      PatchWithComment patchWithComment,
                                                      ApiCallback<RelayAutoConfigRep> _callback)
                                               throws ApiException
        Update a Relay Proxy config (asynchronously) Update a Relay Proxy configuration. Updating a configuration 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:
        id - The relay auto config id (required)
        patchWithComment - (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
      • postRelayAutoConfigCall

        public okhttp3.Call postRelayAutoConfigCall​(RelayAutoConfigPost relayAutoConfigPost,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for postRelayAutoConfig
        Parameters:
        relayAutoConfigPost - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • postRelayAutoConfig

        public RelayAutoConfigRep postRelayAutoConfig​(RelayAutoConfigPost relayAutoConfigPost)
                                               throws ApiException
        Create a new Relay Proxy config Create a Relay Proxy config.
        Parameters:
        relayAutoConfigPost - (required)
        Returns:
        RelayAutoConfigRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • postRelayAutoConfigWithHttpInfo

        public ApiResponse<RelayAutoConfigRep> postRelayAutoConfigWithHttpInfo​(RelayAutoConfigPost relayAutoConfigPost)
                                                                        throws ApiException
        Create a new Relay Proxy config Create a Relay Proxy config.
        Parameters:
        relayAutoConfigPost - (required)
        Returns:
        ApiResponse<RelayAutoConfigRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • postRelayAutoConfigAsync

        public okhttp3.Call postRelayAutoConfigAsync​(RelayAutoConfigPost relayAutoConfigPost,
                                                     ApiCallback<RelayAutoConfigRep> _callback)
                                              throws ApiException
        Create a new Relay Proxy config (asynchronously) Create a Relay Proxy config.
        Parameters:
        relayAutoConfigPost - (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
      • resetRelayAutoConfigCall

        public okhttp3.Call resetRelayAutoConfigCall​(java.lang.String id,
                                                     java.lang.Long expiry,
                                                     ApiCallback _callback)
                                              throws ApiException
        Build call for resetRelayAutoConfig
        Parameters:
        id - The Relay Proxy configuration ID (required)
        expiry - An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • resetRelayAutoConfig

        public RelayAutoConfigRep resetRelayAutoConfig​(java.lang.String id,
                                                       java.lang.Long expiry)
                                                throws ApiException
        Reset Relay Proxy configuration key Reset a Relay Proxy configuration's secret key with an optional expiry time for the old key.
        Parameters:
        id - The Relay Proxy configuration ID (required)
        expiry - An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately. (optional)
        Returns:
        RelayAutoConfigRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • resetRelayAutoConfigWithHttpInfo

        public ApiResponse<RelayAutoConfigRep> resetRelayAutoConfigWithHttpInfo​(java.lang.String id,
                                                                                java.lang.Long expiry)
                                                                         throws ApiException
        Reset Relay Proxy configuration key Reset a Relay Proxy configuration's secret key with an optional expiry time for the old key.
        Parameters:
        id - The Relay Proxy configuration ID (required)
        expiry - An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately. (optional)
        Returns:
        ApiResponse<RelayAutoConfigRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • resetRelayAutoConfigAsync

        public okhttp3.Call resetRelayAutoConfigAsync​(java.lang.String id,
                                                      java.lang.Long expiry,
                                                      ApiCallback<RelayAutoConfigRep> _callback)
                                               throws ApiException
        Reset Relay Proxy configuration key (asynchronously) Reset a Relay Proxy configuration's secret key with an optional expiry time for the old key.
        Parameters:
        id - The Relay Proxy configuration ID (required)
        expiry - An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately. (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