Class ExternalScmConfiguration


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20220421")
    public final class ExternalScmConfiguration
    extends ScmConfiguration
    An external SCM configuration extends a SCM Configuration with necessary data to reach and use the Source Code Management tool/platform used by a Remediation Recipe.

    An external SCM in ADM refers to GitHub, or GitLab.
    Note: Objects should always be created or deserialized using the ExternalScmConfiguration.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ExternalScmConfiguration.Builder, which maintain a set of all explicitly set fields called ExternalScmConfiguration.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getRepositoryUrl

        public String getRepositoryUrl()
        The repository URL for the SCM.

        For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName] For GitLab the expected format is https://gitlab.com/[groupName]/[repoName]

        Returns:
        the value
      • getUsername

        public String getUsername()
        The username for the SCM (to perform operations such as cloning or pushing via HTTP).
        Returns:
        the value
      • getPatSecretId

        public String getPatSecretId()
        The Oracle Cloud Identifier (OCID) of the Private Access Token (PAT) Secret.

        The secret provides the credentials necessary to authenticate against the SCM.

        Returns:
        the value
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Overrides:
        toString in class ScmConfiguration
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation