Google Analytics Admin V1beta Client - Class UpdateDataRetentionSettingsRequest (0.14.0)

Reference documentation and code samples for the Google Analytics Admin V1beta Client class UpdateDataRetentionSettingsRequest.

Request message for UpdateDataRetentionSettings RPC.

Generated from protobuf message google.analytics.admin.v1beta.UpdateDataRetentionSettingsRequest

Namespace

Google \ Analytics \ Admin \ V1beta

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ data_retention_settings Google\Analytics\Admin\V1beta\DataRetentionSettings

Required. The settings to update. The name field is used to identify the settings to be updated.

↳ update_mask Google\Protobuf\FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

getDataRetentionSettings

Required. The settings to update.

The name field is used to identify the settings to be updated.

Returns
TypeDescription
Google\Analytics\Admin\V1beta\DataRetentionSettings|null

hasDataRetentionSettings

clearDataRetentionSettings

setDataRetentionSettings

Required. The settings to update.

The name field is used to identify the settings to be updated.

Parameter
NameDescription
var Google\Analytics\Admin\V1beta\DataRetentionSettings
Returns
TypeDescription
$this

getUpdateMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
dataRetentionSettings Google\Analytics\Admin\V1beta\DataRetentionSettings

Required. The settings to update. The name field is used to identify the settings to be updated.

updateMask Google\Protobuf\FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
TypeDescription
Google\Analytics\Admin\V1beta\UpdateDataRetentionSettingsRequest