com.delphix.masking.api.plugin

Class AlgorithmLogicalField

java.lang.Object

com.delphix.masking.api.plugin.AlgorithmLogicalField

public final class AlgorithmLogicalField
extends java.lang.Object

This immutable object describes a single logical field for a multi-column masking algorithm.

Constructor Summary

Constructors

Constructor and Description
AlgorithmLogicalField(java.lang.String name, MaskingAlgorithm.MaskingType type) Constructor.
AlgorithmLogicalField(java.lang.String name, MaskingAlgorithm.MaskingType type, java.lang.String description, boolean isReadOnly, boolean isOptional) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.lang.String	getName()
MaskingAlgorithm.MaskingType	getType()
boolean	isOptional()
boolean	isReadOnly()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlgorithmLogicalField

public AlgorithmLogicalField(@Nonnull
                             java.lang.String name,
                             @Nonnull
                             MaskingAlgorithm.MaskingType type)

Constructor. The new object is created with no description and isReadOnly and isOptional both set to false.

Parameters:

name - The name of the field, which must be unique among all fields for the algorithm.

type - The mask type of the field.

AlgorithmLogicalField

public AlgorithmLogicalField(@Nonnull
                             java.lang.String name,
                             @Nonnull
                             MaskingAlgorithm.MaskingType type,
                             java.lang.String description,
                             boolean isReadOnly,
                             boolean isOptional)

Constructor

Parameters:

name - The name of the field, which must be unique among all fields for the algorithm.

type - The mask type of the field.

description - An optional text description of the field or its usage

isReadOnly - When this is true, the algorithm consumes this field as input, but does not mask it.

isOptional - Whether this field must be present for the masking assignment to be considered valid.

Method Detail

getName

public java.lang.String getName()

getType

public MaskingAlgorithm.MaskingType getType()

getDescription

public java.lang.String getDescription()

isReadOnly

public boolean isReadOnly()

isOptional

public boolean isOptional()