OnPremiseConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.OnPremiseConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OnPremiseConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the configuration information to connect to GitHub Enterprise Server (on premises).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OnPremiseConfiguration()

Constructors
Constructor and Description
`OnPremiseConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OnPremiseConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getHostUrl()` The GitHub host URL or API endpoint URL.
`String`	`getOrganizationName()` The name of the organization of the GitHub Enterprise Server (in-premise) account you want to connect to.
`S3Path`	`getSslCertificateS3Path()` The path to the SSL certificate stored in an Amazon S3 bucket.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHostUrl(String hostUrl)` The GitHub host URL or API endpoint URL.
`void`	`setOrganizationName(String organizationName)` The name of the organization of the GitHub Enterprise Server (in-premise) account you want to connect to.
`void`	`setSslCertificateS3Path(S3Path sslCertificateS3Path)` The path to the SSL certificate stored in an Amazon S3 bucket.
`String`	`toString()` Returns a string representation of this object.
`OnPremiseConfiguration`	`withHostUrl(String hostUrl)` The GitHub host URL or API endpoint URL.
`OnPremiseConfiguration`	`withOrganizationName(String organizationName)` The name of the organization of the GitHub Enterprise Server (in-premise) account you want to connect to.
`OnPremiseConfiguration`	`withSslCertificateS3Path(S3Path sslCertificateS3Path)` The path to the SSL certificate stored in an Amazon S3 bucket.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OnPremiseConfiguration
```
public OnPremiseConfiguration()
```
- Method Detail
  - setHostUrl
```
public void setHostUrl(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/
  - getHostUrl
```
public String getHostUrl()
```
    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/
  - withHostUrl
```
public OnPremiseConfiguration withHostUrl(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.
  - setOrganizationName
```
public void setOrganizationName(String organizationName)
```
    The name of the organization of the GitHub Enterprise Server (in-premise) 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 (in-premise) 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.
  - getOrganizationName
```
public String getOrganizationName()
```
    The name of the organization of the GitHub Enterprise Server (in-premise) 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 (in-premise) 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.
  - withOrganizationName
```
public OnPremiseConfiguration withOrganizationName(String organizationName)
```
    The name of the organization of the GitHub Enterprise Server (in-premise) 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 (in-premise) 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.
  - setSslCertificateS3Path
```
public void setSslCertificateS3Path(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.
  - getSslCertificateS3Path
```
public S3Path getSslCertificateS3Path()
```
    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.
  - withSslCertificateS3Path
```
public OnPremiseConfiguration withSslCertificateS3Path(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public OnPremiseConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class OnPremiseConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OnPremiseConfiguration

Method Detail

setHostUrl

getHostUrl

withHostUrl

setOrganizationName

getOrganizationName

withOrganizationName

setSslCertificateS3Path

getSslCertificateS3Path

withSslCertificateS3Path

toString

equals

hashCode

clone

marshall