Interface ServiceNowConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ServiceNowConfiguration.Builder,
,ServiceNowConfiguration> SdkBuilder<ServiceNowConfiguration.Builder,
,ServiceNowConfiguration> SdkPojo
- Enclosing class:
ServiceNowConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionauthenticationType
(String authenticationType) The type of authentication used to connect to the ServiceNow instance.authenticationType
(ServiceNowAuthenticationType authenticationType) The type of authentication used to connect to the ServiceNow instance.The ServiceNow instance that the data source connects to.default ServiceNowConfiguration.Builder
knowledgeArticleConfiguration
(Consumer<ServiceNowKnowledgeArticleConfiguration.Builder> knowledgeArticleConfiguration) Configuration information for crawling knowledge articles in the ServiceNow site.knowledgeArticleConfiguration
(ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration) Configuration information for crawling knowledge articles in the ServiceNow site.The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.default ServiceNowConfiguration.Builder
serviceCatalogConfiguration
(Consumer<ServiceNowServiceCatalogConfiguration.Builder> serviceCatalogConfiguration) Configuration information for crawling service catalogs in the ServiceNow site.serviceCatalogConfiguration
(ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration) Configuration information for crawling service catalogs in the ServiceNow site.serviceNowBuildVersion
(String serviceNowBuildVersion) The identifier of the release that the ServiceNow host is running.serviceNowBuildVersion
(ServiceNowBuildVersionType serviceNowBuildVersion) The identifier of the release that the ServiceNow host is running.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source.
- Parameters:
secretArn
- The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceNowBuildVersion
The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
.- Parameters:
serviceNowBuildVersion
- The identifier of the release that the ServiceNow host is running. If the host is not running theLONDON
release, useOTHERS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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, useOTHERS
.- Parameters:
serviceNowBuildVersion
- The identifier of the release that the ServiceNow host is running. If the host is not running theLONDON
release, useOTHERS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
knowledgeArticleConfiguration
ServiceNowConfiguration.Builder knowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration) Configuration information for crawling knowledge articles in the ServiceNow site.
- Parameters:
knowledgeArticleConfiguration
- 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) Configuration information for crawling knowledge articles in the ServiceNow site.
This is a convenience method that creates an instance of theServiceNowKnowledgeArticleConfiguration.Builder
avoiding the need to create one manually viaServiceNowKnowledgeArticleConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toknowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfiguration)
.- Parameters:
knowledgeArticleConfiguration
- a consumer that will call methods onServiceNowKnowledgeArticleConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serviceCatalogConfiguration
ServiceNowConfiguration.Builder serviceCatalogConfiguration(ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration) Configuration information for crawling service catalogs in the ServiceNow site.
- Parameters:
serviceCatalogConfiguration
- 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) Configuration information for crawling service catalogs in the ServiceNow site.
This is a convenience method that creates an instance of theServiceNowServiceCatalogConfiguration.Builder
avoiding the need to create one manually viaServiceNowServiceCatalogConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toserviceCatalogConfiguration(ServiceNowServiceCatalogConfiguration)
.- Parameters:
serviceCatalogConfiguration
- a consumer that will call methods onServiceNowServiceCatalogConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authenticationType
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 Secrets Manager secret in theSecretArn
field. If you chooseOAUTH2
, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.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
- The type of authentication used to connect to the ServiceNow instance. If you chooseHTTP_BASIC
, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in theSecretArn
field. If you chooseOAUTH2
, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.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:
-
authenticationType
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 Secrets Manager secret in theSecretArn
field. If you chooseOAUTH2
, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.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
- The type of authentication used to connect to the ServiceNow instance. If you chooseHTTP_BASIC
, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in theSecretArn
field. If you chooseOAUTH2
, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.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:
-