Class SchemaStatusDetail

    • Method Detail

      • status

        public final SchemaStatus status()

        The status of the schema, indicating if it is ready to query.

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

        Returns:
        The status of the schema, indicating if it is ready to query.
        See Also:
        SchemaStatus
      • statusAsString

        public final String statusAsString()

        The status of the schema, indicating if it is ready to query.

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

        Returns:
        The status of the schema, indicating if it is ready to query.
        See Also:
        SchemaStatus
      • hasReasons

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

        public final List<SchemaStatusReason> reasons()

        The reasons why the schema status is set to its current state.

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

        Returns:
        The reasons why the schema status is set to its current state.
      • analysisRuleType

        public final AnalysisRuleType analysisRuleType()

        The analysis rule type for which the schema status has been evaluated.

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

        Returns:
        The analysis rule type for which the schema status has been evaluated.
        See Also:
        AnalysisRuleType
      • analysisRuleTypeAsString

        public final String analysisRuleTypeAsString()

        The analysis rule type for which the schema status has been evaluated.

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

        Returns:
        The analysis rule type for which the schema status has been evaluated.
        See Also:
        AnalysisRuleType
      • configurations

        public final List<SchemaConfiguration> configurations()

        The configuration details of the schema analysis rule for the given type.

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

        Returns:
        The configuration details of the schema analysis rule for the given type.
      • hasConfigurations

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

        public final List<String> configurationsAsStrings()

        The configuration details of the schema analysis rule for the given type.

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

        Returns:
        The configuration details of the schema analysis rule for the given type.
      • analysisType

        public final AnalysisType analysisType()

        The type of analysis that can be performed on the schema.

        A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.

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

        Returns:
        The type of analysis that can be performed on the schema.

        A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.

        See Also:
        AnalysisType
      • analysisTypeAsString

        public final String analysisTypeAsString()

        The type of analysis that can be performed on the schema.

        A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.

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

        Returns:
        The type of analysis that can be performed on the schema.

        A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.

        See Also:
        AnalysisType
      • 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)