Class CustomRegistryCredentials


  • public final class CustomRegistryCredentials
    extends Object
    Describes the credentials that will be used to access a custom registry during a run.
    • Constructor Detail

      • CustomRegistryCredentials

        public CustomRegistryCredentials()
    • Method Detail

      • username

        public SecretObject username()
        Get the username property: The username for logging into the custom registry.
        Returns:
        the username value.
      • withUsername

        public CustomRegistryCredentials withUsername​(SecretObject username)
        Set the username property: The username for logging into the custom registry.
        Parameters:
        username - the username value to set.
        Returns:
        the CustomRegistryCredentials object itself.
      • password

        public SecretObject password()
        Get the password property: The password for logging into the custom registry. The password is a secret object that allows multiple ways of providing the value for it.
        Returns:
        the password value.
      • withPassword

        public CustomRegistryCredentials withPassword​(SecretObject password)
        Set the password property: The password for logging into the custom registry. The password is a secret object that allows multiple ways of providing the value for it.
        Parameters:
        password - the password value to set.
        Returns:
        the CustomRegistryCredentials object itself.
      • identity

        public String identity()
        Get the identity property: Indicates the managed identity assigned to the custom credential. If a user-assigned identity this value is the Client ID. If a system-assigned identity, the value will be `system`. In the case of a system-assigned identity, the Client ID will be determined by the runner. This identity may be used to authenticate to key vault to retrieve credentials or it may be the only source of authentication used for accessing the registry.
        Returns:
        the identity value.
      • withIdentity

        public CustomRegistryCredentials withIdentity​(String identity)
        Set the identity property: Indicates the managed identity assigned to the custom credential. If a user-assigned identity this value is the Client ID. If a system-assigned identity, the value will be `system`. In the case of a system-assigned identity, the Client ID will be determined by the runner. This identity may be used to authenticate to key vault to retrieve credentials or it may be the only source of authentication used for accessing the registry.
        Parameters:
        identity - the identity value to set.
        Returns:
        the CustomRegistryCredentials object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.