Class WebCrawlerParameters

java.lang.Object
software.amazon.awssdk.services.quicksight.model.WebCrawlerParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WebCrawlerParameters.Builder,WebCrawlerParameters>
@Generated("software.amazon.awssdk:codegen") public final class WebCrawlerParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WebCrawlerParameters.Builder,WebCrawlerParameters>

The parameters for a web crawler data source.

See Also:

  • Method Details

    • webCrawlerAuthType

      public final WebCrawlerAuthType webCrawlerAuthType()

      The authentication type for the web crawler. The type can be one of the following:

      • NO_AUTH: No authentication required.

      • BASIC_AUTH: Basic authentication using username and password.

      • SAML: SAML-based authentication.

      • FORM: Form-based authentication.

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

      Returns:
      The authentication type for the web crawler. The type can be one of the following:

      • NO_AUTH: No authentication required.

      • BASIC_AUTH: Basic authentication using username and password.

      • SAML: SAML-based authentication.

      • FORM: Form-based authentication.

      See Also:

    • webCrawlerAuthTypeAsString

      public final String webCrawlerAuthTypeAsString()

      The authentication type for the web crawler. The type can be one of the following:

      • NO_AUTH: No authentication required.

      • BASIC_AUTH: Basic authentication using username and password.

      • SAML: SAML-based authentication.

      • FORM: Form-based authentication.

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

      Returns:
      The authentication type for the web crawler. The type can be one of the following:

      • NO_AUTH: No authentication required.

      • BASIC_AUTH: Basic authentication using username and password.

      • SAML: SAML-based authentication.

      • FORM: Form-based authentication.

      See Also:

    • usernameFieldXpath

      public final String usernameFieldXpath()

      The XPath expression for locating the username field on the login page.

      Returns:
      The XPath expression for locating the username field on the login page.

    • passwordFieldXpath

      public final String passwordFieldXpath()

      The XPath expression for locating the password field on the login page.

      Returns:
      The XPath expression for locating the password field on the login page.

    • usernameButtonXpath

      public final String usernameButtonXpath()

      The XPath expression for locating the username submit button on the login page.

      Returns:
      The XPath expression for locating the username submit button on the login page.

    • passwordButtonXpath

      public final String passwordButtonXpath()

      The XPath expression for locating the password submit button on the login page.

      Returns:
      The XPath expression for locating the password submit button on the login page.

    • loginPageUrl

      public final String loginPageUrl()

      The URL of the login page for the web crawler to authenticate.

      Returns:
      The URL of the login page for the web crawler to authenticate.

    • webProxyHostName

      public final String webProxyHostName()

      The hostname of the web proxy server for the web crawler.

      Returns:
      The hostname of the web proxy server for the web crawler.

    • webProxyPortNumber

      public final Integer webProxyPortNumber()

      The port number of the web proxy server for the web crawler.

      Returns:
      The port number of the web proxy server for the web crawler.

    • toBuilder

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

    • builder

      public static WebCrawlerParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WebCrawlerParameters.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.