Class DatasetMetadata

    • Method Detail

      • datasetArn

        public final String datasetArn()

        The Amazon Resource Name (ARN) of the dataset.

        Returns:
        The Amazon Resource Name (ARN) of the dataset.
      • datasetName

        public final String datasetName()

        The name of the dataset.

        Returns:
        The name of the dataset.
      • datasetDescription

        public final String datasetDescription()

        The description of the dataset.

        Returns:
        The description of the dataset.
      • dataAggregation

        public final DataAggregation dataAggregation()

        The definition of a data aggregation.

        Returns:
        The definition of a data aggregation.
      • hasFilters

        public final boolean hasFilters()
        For responses, this returns true if the service returned a value for the Filters 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.
      • filters

        public final List<TopicFilter> filters()

        The list of filter definitions.

        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 hasFilters() method.

        Returns:
        The list of filter definitions.
      • hasColumns

        public final boolean hasColumns()
        For responses, this returns true if the service returned a value for the Columns 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.
      • columns

        public final List<TopicColumn> columns()

        The list of column definitions.

        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 hasColumns() method.

        Returns:
        The list of column definitions.
      • hasCalculatedFields

        public final boolean hasCalculatedFields()
        For responses, this returns true if the service returned a value for the CalculatedFields 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.
      • calculatedFields

        public final List<TopicCalculatedField> calculatedFields()

        The list of calculated field definitions.

        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 hasCalculatedFields() method.

        Returns:
        The list of calculated field definitions.
      • hasNamedEntities

        public final boolean hasNamedEntities()
        For responses, this returns true if the service returned a value for the NamedEntities 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.
      • namedEntities

        public final List<TopicNamedEntity> namedEntities()

        The list of named entities definitions.

        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 hasNamedEntities() method.

        Returns:
        The list of named entities definitions.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)