Class DescribeDataSourcesRequest

    • Method Detail

      • filterVariable

        public final DataSourceFilterVariable filterVariable()

        Use one of the following variables to filter a list of DataSource:

        • CreatedAt - Sets the search criteria to DataSource creation dates.

        • Status - Sets the search criteria to DataSource statuses.

        • Name - Sets the search criteria to the contents of DataSource Name.

        • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

        • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.

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

        Returns:
        Use one of the following variables to filter a list of DataSource:

        • CreatedAt - Sets the search criteria to DataSource creation dates.

        • Status - Sets the search criteria to DataSource statuses.

        • Name - Sets the search criteria to the contents of DataSource Name .

        • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

        • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.

        See Also:
        DataSourceFilterVariable
      • filterVariableAsString

        public final String filterVariableAsString()

        Use one of the following variables to filter a list of DataSource:

        • CreatedAt - Sets the search criteria to DataSource creation dates.

        • Status - Sets the search criteria to DataSource statuses.

        • Name - Sets the search criteria to the contents of DataSource Name.

        • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

        • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.

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

        Returns:
        Use one of the following variables to filter a list of DataSource:

        • CreatedAt - Sets the search criteria to DataSource creation dates.

        • Status - Sets the search criteria to DataSource statuses.

        • Name - Sets the search criteria to the contents of DataSource Name .

        • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

        • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.

        See Also:
        DataSourceFilterVariable
      • eq

        public final String eq()

        The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

        Returns:
        The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.
      • gt

        public final String gt()

        The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

        Returns:
        The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.
      • lt

        public final String lt()

        The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

        Returns:
        The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.
      • ge

        public final String ge()

        The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.

        Returns:
        The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.
      • le

        public final String le()

        The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.

        Returns:
        The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.
      • ne

        public final String ne()

        The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

        Returns:
        The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.
      • prefix

        public final String prefix()

        A string that is found at the beginning of a variable, such as Name or Id.

        For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer . To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:

        • 2014-09

        • 2014-09-09

        • 2014-09-09-Holiday

        Returns:
        A string that is found at the beginning of a variable, such as Name or Id.

        For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:

        • 2014-09

        • 2014-09-09

        • 2014-09-09-Holiday

      • sortOrder

        public final SortOrder sortOrder()

        A two-value parameter that determines the sequence of the resulting list of DataSource.

        • asc - Arranges the list in ascending order (A-Z, 0-9).

        • dsc - Arranges the list in descending order (Z-A, 9-0).

        Results are sorted by FilterVariable.

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

        Returns:
        A two-value parameter that determines the sequence of the resulting list of DataSource.

        • asc - Arranges the list in ascending order (A-Z, 0-9).

        • dsc - Arranges the list in descending order (Z-A, 9-0).

        Results are sorted by FilterVariable.

        See Also:
        SortOrder
      • sortOrderAsString

        public final String sortOrderAsString()

        A two-value parameter that determines the sequence of the resulting list of DataSource.

        • asc - Arranges the list in ascending order (A-Z, 0-9).

        • dsc - Arranges the list in descending order (Z-A, 9-0).

        Results are sorted by FilterVariable.

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

        Returns:
        A two-value parameter that determines the sequence of the resulting list of DataSource.

        • asc - Arranges the list in ascending order (A-Z, 0-9).

        • dsc - Arranges the list in descending order (Z-A, 9-0).

        Results are sorted by FilterVariable.

        See Also:
        SortOrder
      • nextToken

        public final String nextToken()

        The ID of the page in the paginated results.

        Returns:
        The ID of the page in the paginated results.
      • limit

        public final Integer limit()

        The maximum number of DataSource to include in the result.

        Returns:
        The maximum number of DataSource to include in the result.
      • 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