Interface OnPremiseConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OnPremiseConfiguration.Builder,OnPremiseConfiguration>, SdkBuilder<OnPremiseConfiguration.Builder,OnPremiseConfiguration>, SdkPojo
Enclosing class:
OnPremiseConfiguration
public static interface OnPremiseConfiguration.Builder extends SdkPojo, CopyableBuilder<OnPremiseConfiguration.Builder,OnPremiseConfiguration>

  • Method Details

    • hostUrl

      OnPremiseConfiguration.Builder hostUrl(String hostUrl)

      The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/

      Parameters:
      hostUrl - The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationName

      OnPremiseConfiguration.Builder organizationName(String organizationName)

      The name of the organization of the GitHub Enterprise Server (on-premises) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown.

      Parameters:
      organizationName - The name of the organization of the GitHub Enterprise Server (on-premises) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sslCertificateS3Path

      OnPremiseConfiguration.Builder sslCertificateS3Path(S3Path sslCertificateS3Path)

      The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection.

      You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

      Parameters:
      sslCertificateS3Path - The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection.

      You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sslCertificateS3Path

      default OnPremiseConfiguration.Builder sslCertificateS3Path(Consumer<S3Path.Builder> sslCertificateS3Path)

      The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection.

      You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

      This is a convenience method that creates an instance of the S3Path.Builder avoiding the need to create one manually via S3Path.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sslCertificateS3Path(S3Path).

      Parameters:
      sslCertificateS3Path - a consumer that will call methods on S3Path.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: