Package com.ibm.cloud.networking.caching_api.v1

Class CachingApi

  • public class CachingApi
extends com.ibm.cloud.sdk.core.service.BaseService
    This document describes CIS caching API.
    Version:
    v1

    • Constructor Detail

      • CachingApi

        public CachingApi​(String crn,
                  String zoneId,
                  String serviceName,
                  com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `CachingApi` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        crn - cloud resource name.
        zoneId - zone id.
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • newInstance

        public static CachingApi newInstance​(String crn,
                                     String zoneId)
        Class method which constructs an instance of the `CachingApi` client. The default service name is used to configure the client instance.
        Parameters:
        crn - cloud resource name.
        zoneId - zone id.
        Returns:
        an instance of the `CachingApi` client using external configuration

      • newInstance

        public static CachingApi newInstance​(String crn,
                                     String zoneId,
                                     String serviceName)
        Class method which constructs an instance of the `CachingApi` client. The specified service name is used to configure the client instance.
        Parameters:
        crn - cloud resource name.
        zoneId - zone id.
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `CachingApi` client using external configuration

      • getCrn

        public String getCrn()
        Gets the crn. cloud resource name.
        Returns:
        the crn

      • setCrn

        public void setCrn​(String crn)
        Sets the crn.
        Parameters:
        crn - the new crn

      • getZoneId

        public String getZoneId()
        Gets the zoneId. zone id.
        Returns:
        the zoneId

      • setZoneId

        public void setZoneId​(String zoneId)
        Sets the zoneId.
        Parameters:
        zoneId - the new zoneId

      • purgeAll

        public com.ibm.cloud.sdk.core.http.ServiceCall<PurgeAllResponse> purgeAll​(PurgeAllOptions purgeAllOptions)
        Purge all. All resources in CDN edge servers' cache should be removed. This may have dramatic affects on your origin server load after performing this action.
        Parameters:
        purgeAllOptions - the PurgeAllOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PurgeAllResponse

      • purgeAll

        public com.ibm.cloud.sdk.core.http.ServiceCall<PurgeAllResponse> purgeAll()
        Purge all. All resources in CDN edge servers' cache should be removed. This may have dramatic affects on your origin server load after performing this action.
        Returns:
        a ServiceCall with a result of type PurgeAllResponse

      • purgeByUrls

        public com.ibm.cloud.sdk.core.http.ServiceCall<PurgeAllResponse> purgeByUrls​(PurgeByUrlsOptions purgeByUrlsOptions)
        Purge URLs. Granularly remove one or more files from CDN edge servers' cache either by specifying URLs.
        Parameters:
        purgeByUrlsOptions - the PurgeByUrlsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PurgeAllResponse

      • purgeByUrls

        public com.ibm.cloud.sdk.core.http.ServiceCall<PurgeAllResponse> purgeByUrls()
        Purge URLs. Granularly remove one or more files from CDN edge servers' cache either by specifying URLs.
        Returns:
        a ServiceCall with a result of type PurgeAllResponse

      • purgeByCacheTags

        public com.ibm.cloud.sdk.core.http.ServiceCall<PurgeAllResponse> purgeByCacheTags​(PurgeByCacheTagsOptions purgeByCacheTagsOptions)
        Purge Cache-Tags. Granularly remove one or more files from CDN edge servers' cache either by specifying the associated Cache-Tags.
        Parameters:
        purgeByCacheTagsOptions - the PurgeByCacheTagsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PurgeAllResponse

      • purgeByCacheTags

        public com.ibm.cloud.sdk.core.http.ServiceCall<PurgeAllResponse> purgeByCacheTags()
        Purge Cache-Tags. Granularly remove one or more files from CDN edge servers' cache either by specifying the associated Cache-Tags.
        Returns:
        a ServiceCall with a result of type PurgeAllResponse

      • purgeByHosts

        public com.ibm.cloud.sdk.core.http.ServiceCall<PurgeAllResponse> purgeByHosts​(PurgeByHostsOptions purgeByHostsOptions)
        Purge host names. Granularly remove one or more files from CDN edge servers' cache either by specifying the hostnames.
        Parameters:
        purgeByHostsOptions - the PurgeByHostsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PurgeAllResponse

      • purgeByHosts

        public com.ibm.cloud.sdk.core.http.ServiceCall<PurgeAllResponse> purgeByHosts()
        Purge host names. Granularly remove one or more files from CDN edge servers' cache either by specifying the hostnames.
        Returns:
        a ServiceCall with a result of type PurgeAllResponse

      • getBrowserCacheTtl

        public com.ibm.cloud.sdk.core.http.ServiceCall<BrowserTTLResponse> getBrowserCacheTtl​(GetBrowserCacheTtlOptions getBrowserCacheTtlOptions)
        Get browser cache TTL setting. Browser Cache TTL (in seconds) specifies how long CDN edge servers cached resources will remain on your visitors' computers.
        Parameters:
        getBrowserCacheTtlOptions - the GetBrowserCacheTtlOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type BrowserTTLResponse

      • getBrowserCacheTtl

        public com.ibm.cloud.sdk.core.http.ServiceCall<BrowserTTLResponse> getBrowserCacheTtl()
        Get browser cache TTL setting. Browser Cache TTL (in seconds) specifies how long CDN edge servers cached resources will remain on your visitors' computers.
        Returns:
        a ServiceCall with a result of type BrowserTTLResponse

      • updateBrowserCacheTtl

        public com.ibm.cloud.sdk.core.http.ServiceCall<BrowserTTLResponse> updateBrowserCacheTtl​(UpdateBrowserCacheTtlOptions updateBrowserCacheTtlOptions)
        Change browser cache TTL setting. Browser Cache TTL (in seconds) specifies how long CDN edge servers cached resources will remain on your visitors' computers.
        Parameters:
        updateBrowserCacheTtlOptions - the UpdateBrowserCacheTtlOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type BrowserTTLResponse

      • updateBrowserCacheTtl

        public com.ibm.cloud.sdk.core.http.ServiceCall<BrowserTTLResponse> updateBrowserCacheTtl()
        Change browser cache TTL setting. Browser Cache TTL (in seconds) specifies how long CDN edge servers cached resources will remain on your visitors' computers.
        Returns:
        a ServiceCall with a result of type BrowserTTLResponse

      • getDevelopmentMode

        public com.ibm.cloud.sdk.core.http.ServiceCall<DeveopmentModeResponse> getDevelopmentMode()
        Get development mode setting. Get development mode setting.
        Returns:
        a ServiceCall with a result of type DeveopmentModeResponse

      • updateDevelopmentMode

        public com.ibm.cloud.sdk.core.http.ServiceCall<DeveopmentModeResponse> updateDevelopmentMode()
        Change development mode setting. Change development mode setting.
        Returns:
        a ServiceCall with a result of type DeveopmentModeResponse

      • getCacheLevel

        public com.ibm.cloud.sdk.core.http.ServiceCall<CacheLevelResponse> getCacheLevel​(GetCacheLevelOptions getCacheLevelOptions)
        Get cache level setting of a specific zone. Get cache level setting of a specific zone.
        Parameters:
        getCacheLevelOptions - the GetCacheLevelOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CacheLevelResponse

      • getCacheLevel

        public com.ibm.cloud.sdk.core.http.ServiceCall<CacheLevelResponse> getCacheLevel()
        Get cache level setting of a specific zone. Get cache level setting of a specific zone.
        Returns:
        a ServiceCall with a result of type CacheLevelResponse

      • updateCacheLevel

        public com.ibm.cloud.sdk.core.http.ServiceCall<CacheLevelResponse> updateCacheLevel​(UpdateCacheLevelOptions updateCacheLevelOptions)
        Set cache level setting for a specific zone. The `basic` setting will cache most static resources (i.e., css, images, and JavaScript). The `simplified` setting will ignore the query string when delivering a cached resource. The `aggressive` setting will cache all static resources, including ones with a query string.
        Parameters:
        updateCacheLevelOptions - the UpdateCacheLevelOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CacheLevelResponse

      • updateCacheLevel

        public com.ibm.cloud.sdk.core.http.ServiceCall<CacheLevelResponse> updateCacheLevel()
        Set cache level setting for a specific zone. The `basic` setting will cache most static resources (i.e., css, images, and JavaScript). The `simplified` setting will ignore the query string when delivering a cached resource. The `aggressive` setting will cache all static resources, including ones with a query string.
        Returns:
        a ServiceCall with a result of type CacheLevelResponse