Package software.amazon.awssdk.services.kendra.model

Class OnPremiseConfiguration

java.lang.Object
software.amazon.awssdk.services.kendra.model.OnPremiseConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OnPremiseConfiguration.Builder,OnPremiseConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class OnPremiseConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OnPremiseConfiguration.Builder,OnPremiseConfiguration>

Provides the configuration information to connect to GitHub Enterprise Server (on premises).

See Also:

  • Method Details

    • hostUrl

      public final String hostUrl()

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

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

    • organizationName

      public final 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.

      Returns:
      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.

    • sslCertificateS3Path

      public final 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.

      Returns:
      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.

    • toBuilder

      public OnPremiseConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OnPremiseConfiguration.Builder,OnPremiseConfiguration>
      Returns:
      a builder for type T

    • builder

      public static OnPremiseConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OnPremiseConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.