ServiceNowConfiguration (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ServiceNowConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides configuration information required to connect to a ServiceNow data source.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ServiceNowConfiguration()

Constructors
Constructor and Description
`ServiceNowConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceNowConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAuthenticationType()` Determines the type of authentication used to connect to the ServiceNow instance.
`String`	`getHostUrl()` The ServiceNow instance that the data source connects to.
`ServiceNowKnowledgeArticleConfiguration`	`getKnowledgeArticleConfiguration()` Provides configuration information for crawling knowledge articles in the ServiceNow site.
`String`	`getSecretArn()` The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
`ServiceNowServiceCatalogConfiguration`	`getServiceCatalogConfiguration()` Provides configuration information for crawling service catalogs in the ServiceNow site.
`String`	`getServiceNowBuildVersion()` The identifier of the release that the ServiceNow host is running.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAuthenticationType(String authenticationType)` Determines the type of authentication used to connect to the ServiceNow instance.
`void`	`setHostUrl(String hostUrl)` The ServiceNow instance that the data source connects to.
`void`	`setKnowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration)` Provides configuration information for crawling knowledge articles in the ServiceNow site.
`void`	`setSecretArn(String secretArn)` The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
`void`	`setServiceCatalogConfiguration(ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration)` Provides configuration information for crawling service catalogs in the ServiceNow site.
`void`	`setServiceNowBuildVersion(String serviceNowBuildVersion)` The identifier of the release that the ServiceNow host is running.
`String`	`toString()` Returns a string representation of this object.
`ServiceNowConfiguration`	`withAuthenticationType(ServiceNowAuthenticationType authenticationType)` Determines the type of authentication used to connect to the ServiceNow instance.
`ServiceNowConfiguration`	`withAuthenticationType(String authenticationType)` Determines the type of authentication used to connect to the ServiceNow instance.
`ServiceNowConfiguration`	`withHostUrl(String hostUrl)` The ServiceNow instance that the data source connects to.
`ServiceNowConfiguration`	`withKnowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration)` Provides configuration information for crawling knowledge articles in the ServiceNow site.
`ServiceNowConfiguration`	`withSecretArn(String secretArn)` The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
`ServiceNowConfiguration`	`withServiceCatalogConfiguration(ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration)` Provides configuration information for crawling service catalogs in the ServiceNow site.
`ServiceNowConfiguration`	`withServiceNowBuildVersion(ServiceNowBuildVersionType serviceNowBuildVersion)` The identifier of the release that the ServiceNow host is running.
`ServiceNowConfiguration`	`withServiceNowBuildVersion(String serviceNowBuildVersion)` The identifier of the release that the ServiceNow host is running.

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

- Constructor Detail
  - ServiceNowConfiguration
```
public ServiceNowConfiguration()
```
- Method Detail
  - setHostUrl
```
public void setHostUrl(String hostUrl)
```
    The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
    
    Parameters:
    
    hostUrl - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
  - getHostUrl
```
public String getHostUrl()
```
    The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
    
    Returns:
    
    The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
  - withHostUrl
```
public ServiceNowConfiguration withHostUrl(String hostUrl)
```
    The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
    
    Parameters:
    
    hostUrl - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretArn
```
public void setSecretArn(String secretArn)
```
    The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
    
    Parameters:
    
    secretArn - The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
  - getSecretArn
```
public String getSecretArn()
```
    The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
  - withSecretArn
```
public ServiceNowConfiguration withSecretArn(String secretArn)
```
    The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
    
    Parameters:
    
    secretArn - The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceNowBuildVersion
```
public void setServiceNowBuildVersion(String serviceNowBuildVersion)
```
    The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
    
    Parameters:
    
    serviceNowBuildVersion - The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
    
    See Also:
    
    ServiceNowBuildVersionType
  - getServiceNowBuildVersion
```
public String getServiceNowBuildVersion()
```
    The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
    
    Returns:
    
    The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
    
    See Also:
    
    ServiceNowBuildVersionType
  - withServiceNowBuildVersion
```
public ServiceNowConfiguration withServiceNowBuildVersion(String serviceNowBuildVersion)
```
    The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
    
    Parameters:
    
    serviceNowBuildVersion - The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ServiceNowBuildVersionType
  - withServiceNowBuildVersion
```
public ServiceNowConfiguration withServiceNowBuildVersion(ServiceNowBuildVersionType serviceNowBuildVersion)
```
    The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
    
    Parameters:
    
    serviceNowBuildVersion - The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ServiceNowBuildVersionType
  - setKnowledgeArticleConfiguration
```
public void setKnowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration)
```
    Provides configuration information for crawling knowledge articles in the ServiceNow site.
    
    Parameters:
    
    knowledgeArticleConfiguration - Provides configuration information for crawling knowledge articles in the ServiceNow site.
  - getKnowledgeArticleConfiguration
```
public ServiceNowKnowledgeArticleConfiguration getKnowledgeArticleConfiguration()
```
    Provides configuration information for crawling knowledge articles in the ServiceNow site.
    
    Returns:
    
    Provides configuration information for crawling knowledge articles in the ServiceNow site.
  - withKnowledgeArticleConfiguration
```
public ServiceNowConfiguration withKnowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration)
```
    Provides configuration information for crawling knowledge articles in the ServiceNow site.
    
    Parameters:
    
    knowledgeArticleConfiguration - Provides configuration information for crawling knowledge articles in the ServiceNow site.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceCatalogConfiguration
```
public void setServiceCatalogConfiguration(ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration)
```
    Provides configuration information for crawling service catalogs in the ServiceNow site.
    
    Parameters:
    
    serviceCatalogConfiguration - Provides configuration information for crawling service catalogs in the ServiceNow site.
  - getServiceCatalogConfiguration
```
public ServiceNowServiceCatalogConfiguration getServiceCatalogConfiguration()
```
    Provides configuration information for crawling service catalogs in the ServiceNow site.
    
    Returns:
    
    Provides configuration information for crawling service catalogs in the ServiceNow site.
  - withServiceCatalogConfiguration
```
public ServiceNowConfiguration withServiceCatalogConfiguration(ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration)
```
    Provides configuration information for crawling service catalogs in the ServiceNow site.
    
    Parameters:
    
    serviceCatalogConfiguration - Provides configuration information for crawling service catalogs in the ServiceNow site.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthenticationType
```
public void setAuthenticationType(String authenticationType)
```
    Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.
    
    When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
    
    Parameters:
    
    authenticationType - Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.
    
    When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
    
    See Also:
    
    ServiceNowAuthenticationType
  - getAuthenticationType
```
public String getAuthenticationType()
```
    Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.
    
    When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
    
    Returns:
    
    Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.
    
    When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
    
    See Also:
    
    ServiceNowAuthenticationType
  - withAuthenticationType
```
public ServiceNowConfiguration withAuthenticationType(String authenticationType)
```
    Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.
    
    When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
    
    Parameters:
    
    authenticationType - Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.
    
    When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ServiceNowAuthenticationType
  - withAuthenticationType
```
public ServiceNowConfiguration withAuthenticationType(ServiceNowAuthenticationType authenticationType)
```
    Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.
    
    When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
    
    Parameters:
    
    authenticationType - Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.
    
    When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ServiceNowAuthenticationType
  - 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 ServiceNowConfiguration 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 ServiceNowConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceNowConfiguration

Method Detail

setHostUrl

getHostUrl

withHostUrl

setSecretArn

getSecretArn

withSecretArn

setServiceNowBuildVersion

getServiceNowBuildVersion

withServiceNowBuildVersion

withServiceNowBuildVersion

setKnowledgeArticleConfiguration

getKnowledgeArticleConfiguration

withKnowledgeArticleConfiguration

setServiceCatalogConfiguration

getServiceCatalogConfiguration

withServiceCatalogConfiguration

setAuthenticationType

getAuthenticationType

withAuthenticationType

withAuthenticationType

toString

equals

hashCode

clone

marshall