Method apply_profile

couchbase/options.py:411–429

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

(self,
                      profile_name  # type: Union[KnownConfigProfiles, str]
                      )

    """  # noqa: E501

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

        Apply the provided ConfigProfile options.

        Args:
            profile_name ([:class:`~couchbase.options.KnownConfigProfiles`, str]):  The name of the profile to apply
                toward ClusterOptions.
            authenticator (Union[:class:`~couchbase.auth.PasswordAuthenticator`, :class:`~couchbaes.auth.CertificateAuthenticator`]): An authenticator instance.

        Raises:
            :class:`~couchbase.exceptions.InvalidArgumentException`: If the specified profile is not registered.

        """  # noqa: E501
        prof_name = profile_name.value if isinstance(profile_name, KnownConfigProfiles) else profile_name
        CONFIG_PROFILES.apply_profile(prof_name, self)

    @classmethod
    def create_options_with_profile(cls,