Class ServiceNowConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ServiceNowConfiguration.Builder,
ServiceNowConfiguration>
Provides the configuration information to connect to ServiceNow as your data source.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe type of authentication used to connect to the ServiceNow instance.final String
The type of authentication used to connect to the ServiceNow instance.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
hostUrl()
The ServiceNow instance that the data source connects to.Configuration information for crawling knowledge articles in the ServiceNow site.final String
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.static Class
<? extends ServiceNowConfiguration.Builder> Configuration information for crawling service catalogs in the ServiceNow site.The identifier of the release that the ServiceNow host is running.final String
The identifier of the release that the ServiceNow host is running.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hostUrl
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.
-
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:
- 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.
-
serviceNowBuildVersion
The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
.If the service returns an enum value that is not available in the current SDK version,
serviceNowBuildVersion
will returnServiceNowBuildVersionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserviceNowBuildVersionAsString()
.- Returns:
- The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
. - See Also:
-
serviceNowBuildVersionAsString
The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
.If the service returns an enum value that is not available in the current SDK version,
serviceNowBuildVersion
will returnServiceNowBuildVersionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserviceNowBuildVersionAsString()
.- Returns:
- The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
. - See Also:
-
knowledgeArticleConfiguration
Configuration information for crawling knowledge articles in the ServiceNow site.
- Returns:
- Configuration information for crawling knowledge articles in the ServiceNow site.
-
serviceCatalogConfiguration
Configuration information for crawling service catalogs in the ServiceNow site.
- Returns:
- Configuration information for crawling service catalogs in the ServiceNow site.
-
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.If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnServiceNowAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- 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. - See Also:
-
authenticationTypeAsString
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.If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnServiceNowAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- 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. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ServiceNowConfiguration.Builder,
ServiceNowConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-