software.amazon.awssdk.services.kendra.model

Class ServiceNowConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.ServiceNowConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ServiceNowConfiguration.Builder,ServiceNowConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class ServiceNowConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ServiceNowConfiguration.Builder,ServiceNowConfiguration>

Provides the configuration information to connect to ServiceNow as your data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServiceNowConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
ServiceNowAuthenticationType	authenticationType() The type of authentication used to connect to the ServiceNow instance.
String	authenticationTypeAsString() The type of authentication used to connect to the ServiceNow instance.
static ServiceNowConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hostUrl() The ServiceNow instance that the data source connects to.
ServiceNowKnowledgeArticleConfiguration	knowledgeArticleConfiguration() Configuration information for crawling knowledge articles in the ServiceNow site.
List<SdkField<?>>	sdkFields()
String	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.
static Class<? extends ServiceNowConfiguration.Builder>	serializableBuilderClass()
ServiceNowServiceCatalogConfiguration	serviceCatalogConfiguration() Configuration information for crawling service catalogs in the ServiceNow site.
ServiceNowBuildVersionType	serviceNowBuildVersion() The identifier of the release that the ServiceNow host is running.
String	serviceNowBuildVersionAsString() The identifier of the release that the ServiceNow host is running.
ServiceNowConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hostUrl

public final String 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

public final String 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

public final ServiceNowBuildVersionType serviceNowBuildVersion()

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

If the service returns an enum value that is not available in the current SDK version, serviceNowBuildVersion will return ServiceNowBuildVersionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceNowBuildVersionAsString().

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

serviceNowBuildVersionAsString

public final String serviceNowBuildVersionAsString()

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

If the service returns an enum value that is not available in the current SDK version, serviceNowBuildVersion will return ServiceNowBuildVersionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceNowBuildVersionAsString().

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

knowledgeArticleConfiguration

public final ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration()

Configuration information for crawling knowledge articles in the ServiceNow site.

Returns:

Configuration information for crawling knowledge articles in the ServiceNow site.

serviceCatalogConfiguration

public final ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration()

Configuration information for crawling service catalogs in the ServiceNow site.

Returns:

Configuration information for crawling service catalogs in the ServiceNow site.

authenticationType

public final ServiceNowAuthenticationType 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 the SecretArn field. If you choose OAUTH2, 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 return ServiceNowAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

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 the SecretArn field. If you choose OAUTH2, 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:

ServiceNowAuthenticationType

authenticationTypeAsString

public final String 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 the SecretArn field. If you choose OAUTH2, 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 return ServiceNowAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

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 the SecretArn field. If you choose OAUTH2, 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:

ServiceNowAuthenticationType

toBuilder

public ServiceNowConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceNowConfiguration.Builder,ServiceNowConfiguration>

builder

public static ServiceNowConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ServiceNowConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo