Class FullDevOpsAPIURLOptions

astrapy/utils/api_options.py:795–855

The group of settings for the API Options that determines the URL used to reach the DevOps API. This is the "full" version of the class, with the guarantee that all of its members have defined values. As such, this is what classes such as DataAPIClient, Database, Table, Collect

@dataclass
class FullDevOpsAPIURLOptions(DevOpsAPIURLOptions):
    """
    The group of settings for the API Options that determines the URL used to
    reach the DevOps API.

    This is the "full" version of the class, with the guarantee that all of its members
    have defined values. As such, this is what classes such as DataAPIClient, Database,
    Table, Collection and so on have in their `.api_options` attribute -- as opposed
    to the (non-full) `DevOpsAPIURLOptions` counterpart class: the latter admits "unset"
    attributes and is used to override specific settings. However, only in very specific
    customized scenarios should it be necessary to override the default settings.

    The default settings for this class depend on the environment; in particular,
    for non-Astra environments (such as HCD or DSE) there is no DevOps API, hence
    these settings are irrelevant.

    Attributes:
        dev_ops_url: This can be used to specify the URL to the DevOps API. The default
            for production Astra DB is "https://api.astra.datastax.com" and should
            never need to be overridden.
        dev_ops_api_version: this specifies a version for the DevOps API
            (the default is "v2"). It should never need to be overridden.
    """

    dev_ops_url: str
    dev_ops_api_version: str | None

    def __init__(
        self,
        *,
        dev_ops_url: str,
        dev_ops_api_version: str | None,
    ) -> None:
        DevOpsAPIURLOptions.__init__(
            self,
            dev_ops_url=dev_ops_url,
            dev_ops_api_version=dev_ops_api_version,
        )

    def with_override(self, other: DevOpsAPIURLOptions) -> FullDevOpsAPIURLOptions:
        """
        Given an "overriding" set of options, possibly not defined in all its
        attributes, apply the override logic and return a new full options object.

        Args:
            other: a not-necessarily-fully-specified options object. All its defined
                settings take precedence.
        """

        return FullDevOpsAPIURLOptions(
            dev_ops_url=(
                other.dev_ops_url
                if not isinstance(other.dev_ops_url, UnsetType)
                else self.dev_ops_url
            ),
            dev_ops_api_version=(
                other.dev_ops_api_version
                if not isinstance(other.dev_ops_api_version, UnsetType)