Data Loss Prevention V2 Client - Class DateShiftConfig (2.0.0)

Reference documentation and code samples for the Data Loss Prevention V2 Client class DateShiftConfig.

Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more.

Generated from protobuf message google.privacy.dlp.v2.DateShiftConfig

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ upper_bound_days int

Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future.

↳ lower_bound_days int

Required. For example, -5 means shift date to at most 5 days back in the past.

↳ context Google\Cloud\Dlp\V2\FieldId

Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context.

↳ crypto_key Google\Cloud\Dlp\V2\CryptoKey

Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items.

getUpperBoundDays

Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction.

For example, 3 means shift date to at most 3 days into the future.

Returns
Type Description
int

setUpperBoundDays

Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction.

For example, 3 means shift date to at most 3 days into the future.

Parameter
Name Description
var int
Returns
Type Description
$this

getLowerBoundDays

Required. For example, -5 means shift date to at most 5 days back in the past.

Returns
Type Description
int

setLowerBoundDays

Required. For example, -5 means shift date to at most 5 days back in the past.

Parameter
Name Description
var int
Returns
Type Description
$this

getContext

Points to the field that contains the context, for example, an entity id.

If set, must also set cryptoKey. If set, shift will be consistent for the given context.

Returns
Type Description
Google\Cloud\Dlp\V2\FieldId|null

hasContext

clearContext

setContext

Points to the field that contains the context, for example, an entity id.

If set, must also set cryptoKey. If set, shift will be consistent for the given context.

Parameter
Name Description
var Google\Cloud\Dlp\V2\FieldId
Returns
Type Description
$this

getCryptoKey

Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items.

Returns
Type Description
Google\Cloud\Dlp\V2\CryptoKey|null

hasCryptoKey

setCryptoKey

Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items.

Parameter
Name Description
var Google\Cloud\Dlp\V2\CryptoKey
Returns
Type Description
$this

getMethod

Returns
Type Description
string