Package software.amazon.awssdk.services.frauddetector.model

Class CreateDetectorVersionRequest

    • Method Detail

      • detectorId

        public final String detectorId()

        The ID of the detector under which you want to create a new version.

        Returns:
        The ID of the detector under which you want to create a new version.

      • description

        public final String description()

        The description of the detector version.

        Returns:
        The description of the detector version.

      • hasExternalModelEndpoints

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

      • externalModelEndpoints

        public final List<String> externalModelEndpoints()

        The Amazon Sagemaker model endpoints to include in the detector version.

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

        Returns:
        The Amazon Sagemaker model endpoints to include in the detector version.

      • hasRules

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

      • rules

        public final List<Rule> rules()

        The rules to include in the detector version.

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

        Returns:
        The rules to include in the detector version.

      • hasModelVersions

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

      • modelVersions

        public final List<ModelVersion> modelVersions()

        The model versions to include in the detector version.

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

        Returns:
        The model versions to include in the detector version.

      • ruleExecutionMode

        public final RuleExecutionMode ruleExecutionMode()

        The rule execution mode for the rules included in the detector version.

        You can define and edit the rule mode at the detector version level, when it is in draft status.

        If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

        If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

        The default behavior is FIRST_MATCHED.

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

        Returns:
        The rule execution mode for the rules included in the detector version.

        You can define and edit the rule mode at the detector version level, when it is in draft status.

        If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

        If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

        The default behavior is FIRST_MATCHED.

        See Also:
        RuleExecutionMode

      • ruleExecutionModeAsString

        public final String ruleExecutionModeAsString()

        The rule execution mode for the rules included in the detector version.

        You can define and edit the rule mode at the detector version level, when it is in draft status.

        If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

        If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

        The default behavior is FIRST_MATCHED.

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

        Returns:
        The rule execution mode for the rules included in the detector version.

        You can define and edit the rule mode at the detector version level, when it is in draft status.

        If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

        If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

        The default behavior is FIRST_MATCHED.

        See Also:
        RuleExecutionMode

      • hasTags

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

      • tags

        public final List<Tag> tags()

        A collection of key and value pairs.

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

        Returns:
        A collection of key and value pairs.

      • 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