Method apply_profile

couchbase/options.py:255–275

**VOLATILE** This API is subject to change at any time. Apply the provided ConfigProfile options. Args: profile_name (str): The name of the profile to apply. options (:class:`~couchbase.options.ClusterOptions`): The options to apply the ConfigProfi

(self,
                      profile_name,  # type: str
                      options  # type: ClusterOptions
                      )

        self.register_profile(KnownConfigProfiles.WanDevelopment.value, WanDevelopmentProfile())

    def apply_profile(self,
                      profile_name,  # type: str
                      options  # type: ClusterOptions
                      ) -> None:
        """
        **VOLATILE** This API is subject to change at any time.

        Apply the provided ConfigProfile options.

        Args:
            profile_name (str):  The name of the profile to apply.
            options (:class:`~couchbase.options.ClusterOptions`): The options to apply the ConfigProfile options
                toward. The ConfigProfile options will override any matching option(s) previously set.

        Raises:
            :class:`~couchbase.exceptions.InvalidArgumentException`: If the specified profile is not registered.
        """
        if profile_name not in self._profiles:
            raise InvalidArgumentException(f'{profile_name} is not a registered profile.')

        self._profiles[profile_name].apply(options)

    def register_profile(self,
                         profile_name,  # type: str