Class SharePointSourceConfiguration

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

The endpoint information to connect to your SharePoint data source.

See Also:

  • Method Details

    • authType

      public final SharePointAuthType authType()

      The supported authentication type to authenticate and connect to your SharePoint site/sites.

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

      Returns:
      The supported authentication type to authenticate and connect to your SharePoint site/sites.
      See Also:

    • authTypeAsString

      public final String authTypeAsString()

      The supported authentication type to authenticate and connect to your SharePoint site/sites.

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

      Returns:
      The supported authentication type to authenticate and connect to your SharePoint site/sites.
      See Also:

    • credentialsSecretArn

      public final String credentialsSecretArn()

      The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.

      Returns:
      The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.

    • domain

      public final String domain()

      The domain of your SharePoint instance or site URL/URLs.

      Returns:
      The domain of your SharePoint instance or site URL/URLs.

    • hostType

      public final SharePointHostType hostType()

      The supported host type, whether online/cloud or server/on-premises.

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

      Returns:
      The supported host type, whether online/cloud or server/on-premises.
      See Also:

    • hostTypeAsString

      public final String hostTypeAsString()

      The supported host type, whether online/cloud or server/on-premises.

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

      Returns:
      The supported host type, whether online/cloud or server/on-premises.
      See Also:

    • hasSiteUrls

      public final boolean hasSiteUrls()
      For responses, this returns true if the service returned a value for the SiteUrls property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • siteUrls

      public final List<String> siteUrls()

      A list of one or more SharePoint site URLs.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSiteUrls() method.

      Returns:
      A list of one or more SharePoint site URLs.

    • tenantId

      public final String tenantId()

      The identifier of your Microsoft 365 tenant.

      Returns:
      The identifier of your Microsoft 365 tenant.

    • toBuilder

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

    • builder

      public static SharePointSourceConfiguration.Builder builder()

    • serializableBuilderClass

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