software.amazon.awssdk.services.kendra.model

Interface ServiceNowConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ServiceNowConfiguration.Builder,ServiceNowConfiguration>, SdkBuilder<ServiceNowConfiguration.Builder,ServiceNowConfiguration>, SdkPojo

Enclosing class:

ServiceNowConfiguration

public static interface ServiceNowConfiguration.Builder
extends SdkPojo, CopyableBuilder<ServiceNowConfiguration.Builder,ServiceNowConfiguration>

Method Summary

Modifier and Type	Method and Description
ServiceNowConfiguration.Builder	authenticationType(ServiceNowAuthenticationType authenticationType) Determines the type of authentication used to connect to the ServiceNow instance.
ServiceNowConfiguration.Builder	authenticationType(String authenticationType) Determines the type of authentication used to connect to the ServiceNow instance.
ServiceNowConfiguration.Builder	hostUrl(String hostUrl) The ServiceNow instance that the data source connects to.
default ServiceNowConfiguration.Builder	knowledgeArticleConfiguration(Consumer<ServiceNowKnowledgeArticleConfiguration.Builder> knowledgeArticleConfiguration) Provides configuration information for crawling knowledge articles in the ServiceNow site.
ServiceNowConfiguration.Builder	knowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration) Provides configuration information for crawling knowledge articles in the ServiceNow site.
ServiceNowConfiguration.Builder	secretArn(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.
default ServiceNowConfiguration.Builder	serviceCatalogConfiguration(Consumer<ServiceNowServiceCatalogConfiguration.Builder> serviceCatalogConfiguration) Provides configuration information for crawling service catalogs in the ServiceNow site.
ServiceNowConfiguration.Builder	serviceCatalogConfiguration(ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration) Provides configuration information for crawling service catalogs in the ServiceNow site.
ServiceNowConfiguration.Builder	serviceNowBuildVersion(ServiceNowBuildVersionType serviceNowBuildVersion) The identifier of the release that the ServiceNow host is running.
ServiceNowConfiguration.Builder	serviceNowBuildVersion(String serviceNowBuildVersion) The identifier of the release that the ServiceNow host is running.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

hostUrl

ServiceNowConfiguration.Builder hostUrl(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.

secretArn

ServiceNowConfiguration.Builder secretArn(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.

serviceNowBuildVersion

ServiceNowConfiguration.Builder serviceNowBuildVersion(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, ServiceNowBuildVersionType

serviceNowBuildVersion

ServiceNowConfiguration.Builder serviceNowBuildVersion(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, ServiceNowBuildVersionType

knowledgeArticleConfiguration

ServiceNowConfiguration.Builder knowledgeArticleConfiguration(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.

knowledgeArticleConfiguration

default ServiceNowConfiguration.Builder knowledgeArticleConfiguration(Consumer<ServiceNowKnowledgeArticleConfiguration.Builder> knowledgeArticleConfiguration)

Provides configuration information for crawling knowledge articles in the ServiceNow site.

This is a convenience that creates an instance of the ServiceNowKnowledgeArticleConfiguration.Builder avoiding the need to create one manually via ServiceNowKnowledgeArticleConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to knowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfiguration).

Parameters:

knowledgeArticleConfiguration - a consumer that will call methods on ServiceNowKnowledgeArticleConfiguration.Builder

Returns:

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

See Also:

knowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfiguration)

serviceCatalogConfiguration

ServiceNowConfiguration.Builder serviceCatalogConfiguration(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.

serviceCatalogConfiguration

default ServiceNowConfiguration.Builder serviceCatalogConfiguration(Consumer<ServiceNowServiceCatalogConfiguration.Builder> serviceCatalogConfiguration)

Provides configuration information for crawling service catalogs in the ServiceNow site.

This is a convenience that creates an instance of the ServiceNowServiceCatalogConfiguration.Builder avoiding the need to create one manually via ServiceNowServiceCatalogConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serviceCatalogConfiguration(ServiceNowServiceCatalogConfiguration).

Parameters:

serviceCatalogConfiguration - a consumer that will call methods on ServiceNowServiceCatalogConfiguration.Builder

Returns:

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

See Also:

serviceCatalogConfiguration(ServiceNowServiceCatalogConfiguration)

authenticationType

ServiceNowConfiguration.Builder authenticationType(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, ServiceNowAuthenticationType

authenticationType

ServiceNowConfiguration.Builder authenticationType(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, ServiceNowAuthenticationType