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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OnPremiseConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static OnPremiseConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hostUrl()	The GitHub host URL or API endpoint URL.
String	organizationName()	The name of the organization of the GitHub Enterprise Server (on-premises) account you want to connect to.
List<SdkField<?>>	sdkFields()
static Class<? extends OnPremiseConfiguration.Builder>	serializableBuilderClass()
S3Path	sslCertificateS3Path()	The path to the SSL certificate stored in an Amazon S3 bucket.
OnPremiseConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<OnPremiseConfiguration.Builder,OnPremiseConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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