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

Class CreateDetectorVersionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.frauddetector.model.FraudDetectorRequest
software.amazon.awssdk.services.frauddetector.model.CreateDetectorVersionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDetectorVersionRequest.Builder,CreateDetectorVersionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDetectorVersionRequest extends FraudDetectorRequest implements ToCopyableBuilder<CreateDetectorVersionRequest.Builder,CreateDetectorVersionRequest>

  • Method Details

    • 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:

    • 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:

    • 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.

    • toBuilder

      public CreateDetectorVersionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDetectorVersionRequest.Builder,CreateDetectorVersionRequest>
      Specified by:
      toBuilder in class FraudDetectorRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDetectorVersionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDetectorVersionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.