Class ServiceNowConfiguration

java.lang.Object
software.amazon.awssdk.services.kendra.model.ServiceNowConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ServiceNowConfiguration.Builder,ServiceNowConfiguration>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public ServiceNowConfiguration.Builder 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 interface ToCopyableBuilder<ServiceNowConfiguration.Builder,ServiceNowConfiguration>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.