Class GetSchemaAnalysisRuleRequest

    • Method Detail

      • collaborationIdentifier

        public final String collaborationIdentifier()

        A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

        Returns:
        A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
      • name

        public final String name()

        The name of the schema to retrieve the analysis rule for.

        Returns:
        The name of the schema to retrieve the analysis rule for.
      • type

        public final AnalysisRuleType type()

        The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

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

        Returns:
        The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
        See Also:
        AnalysisRuleType
      • typeAsString

        public final String typeAsString()

        The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

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

        Returns:
        The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
        See Also:
        AnalysisRuleType
      • 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