Class DataSourceConfiguration

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

Specifies the data storage option chosen for requesting Places.

When using Amazon Location Places:

  • If using HERE Technologies as a data provider, you can't store results for locations in Japan by setting IntendedUse to Storage. parameter.

  • Under the MobileAssetTracking or MobilAssetManagement pricing plan, you can't store results from your place index resources by setting IntendedUse to Storage. This returns a validation exception error.

For more information, see the AWS Service Terms for Amazon Location Service.

See Also:

  • Method Details

    • intendedUse

      public final IntendedUse intendedUse()

      Specifies how the results of an operation will be stored by the caller.

      Valid values include:

      • SingleUse specifies that the results won't be stored.

      • Storage specifies that the result can be cached or stored in a database.

      Default value: SingleUse

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

      Returns:
      Specifies how the results of an operation will be stored by the caller.

      Valid values include:

      • SingleUse specifies that the results won't be stored.

      • Storage specifies that the result can be cached or stored in a database.

      Default value: SingleUse

      See Also:

    • intendedUseAsString

      public final String intendedUseAsString()

      Specifies how the results of an operation will be stored by the caller.

      Valid values include:

      • SingleUse specifies that the results won't be stored.

      • Storage specifies that the result can be cached or stored in a database.

      Default value: SingleUse

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

      Returns:
      Specifies how the results of an operation will be stored by the caller.

      Valid values include:

      • SingleUse specifies that the results won't be stored.

      • Storage specifies that the result can be cached or stored in a database.

      Default value: SingleUse

      See Also:

    • toBuilder

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

    • builder

      public static DataSourceConfiguration.Builder builder()

    • serializableBuilderClass

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