Documentation

UpdateNetworkCameraQualityRetentionProfile implements ModelInterface, ArrayAccess

UpdateNetworkCameraQualityRetentionProfile Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes and Traits

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getAudioRecordingEnabled()  : bool
Gets audio_recording_enabled
getCloudArchiveEnabled()  : bool
Gets cloud_archive_enabled
getMaxRetentionDays()  : int
Gets max_retention_days
getModelName()  : string
The original name of the model.
getMotionBasedRetentionEnabled()  : bool
Gets motion_based_retention_enabled
getMotionDetectorVersion()  : int
Gets motion_detector_version
getName()  : string
Gets name
getRestrictedBandwidthModeEnabled()  : bool
Gets restricted_bandwidth_mode_enabled
getScheduleId()  : string
Gets schedule_id
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getVideoSettings()  : NetworksnetworkIdcameraqualityRetentionProfilesVideoSettings
Gets video_settings
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAudioRecordingEnabled()  : $this
Sets audio_recording_enabled
setCloudArchiveEnabled()  : $this
Sets cloud_archive_enabled
setMaxRetentionDays()  : $this
Sets max_retention_days
setMotionBasedRetentionEnabled()  : $this
Sets motion_based_retention_enabled
setMotionDetectorVersion()  : $this
Sets motion_detector_version
setName()  : $this
Sets name
setRestrictedBandwidthModeEnabled()  : $this
Sets restricted_bandwidth_mode_enabled
setScheduleId()  : $this
Sets schedule_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setVideoSettings()  : $this
Sets video_settings
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['name' => 'name', 'motion_based_retention_enabled' => 'motionBasedRetentionEnabled', 'restricted_bandwidth_mode_enabled' => 'restrictedBandwidthModeEnabled', 'audio_recording_enabled' => 'audioRecordingEnabled', 'cloud_archive_enabled' => 'cloudArchiveEnabled', 'motion_detector_version' => 'motionDetectorVersion', 'schedule_id' => 'scheduleId', 'max_retention_days' => 'maxRetentionDays', 'video_settings' => 'videoSettings']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['name' => 'getName', 'motion_based_retention_enabled' => 'getMotionBasedRetentionEnabled', 'restricted_bandwidth_mode_enabled' => 'getRestrictedBandwidthModeEnabled', 'audio_recording_enabled' => 'getAudioRecordingEnabled', 'cloud_archive_enabled' => 'getCloudArchiveEnabled', 'motion_detector_version' => 'getMotionDetectorVersion', 'schedule_id' => 'getScheduleId', 'max_retention_days' => 'getMaxRetentionDays', 'video_settings' => 'getVideoSettings']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['name' => 'setName', 'motion_based_retention_enabled' => 'setMotionBasedRetentionEnabled', 'restricted_bandwidth_mode_enabled' => 'setRestrictedBandwidthModeEnabled', 'audio_recording_enabled' => 'setAudioRecordingEnabled', 'cloud_archive_enabled' => 'setCloudArchiveEnabled', 'motion_detector_version' => 'setMotionDetectorVersion', 'schedule_id' => 'setScheduleId', 'max_retention_days' => 'setMaxRetentionDays', 'video_settings' => 'setVideoSettings']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['name' => null, 'motion_based_retention_enabled' => null, 'restricted_bandwidth_mode_enabled' => null, 'audio_recording_enabled' => null, 'cloud_archive_enabled' => null, 'motion_detector_version' => null, 'schedule_id' => null, 'max_retention_days' => null, 'video_settings' => null]

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['name' => 'string', 'motion_based_retention_enabled' => 'bool', 'restricted_bandwidth_mode_enabled' => 'bool', 'audio_recording_enabled' => 'bool', 'cloud_archive_enabled' => 'bool', 'motion_detector_version' => 'int', 'schedule_id' => 'string', 'max_retention_days' => 'int', 'video_settings' => '\Swagger\Client\Model\NetworksnetworkIdcameraqualityRetentionProfilesVideoSettings']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void —

setAudioRecordingEnabled()

Sets audio_recording_enabled

public setAudioRecordingEnabled(bool $audio_recording_enabled) : $this
Parameters
$audio_recording_enabled : bool

Whether or not to record audio. Can be either true or false. Defaults to false.

Return values
$this —

setCloudArchiveEnabled()

Sets cloud_archive_enabled

public setCloudArchiveEnabled(bool $cloud_archive_enabled) : $this
Parameters
$cloud_archive_enabled : bool

Create redundant video backup using Cloud Archive. Can be either true or false. Defaults to false.

Return values
$this —

setMaxRetentionDays()

Sets max_retention_days

public setMaxRetentionDays(int $max_retention_days) : $this
Parameters
$max_retention_days : int

The maximum number of days for which the data will be stored, or 'null' to keep data until storage space runs out. If the former, it can be one of [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 14, 30, 60, 90] days.

Return values
$this —

setMotionBasedRetentionEnabled()

Sets motion_based_retention_enabled

public setMotionBasedRetentionEnabled(bool $motion_based_retention_enabled) : $this
Parameters
$motion_based_retention_enabled : bool

Deletes footage older than 3 days in which no motion was detected. Can be either true or false. Defaults to false.

Return values
$this —

setMotionDetectorVersion()

Sets motion_detector_version

public setMotionDetectorVersion(int $motion_detector_version) : $this
Parameters
$motion_detector_version : int

The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.

Return values
$this —

setRestrictedBandwidthModeEnabled()

Sets restricted_bandwidth_mode_enabled

public setRestrictedBandwidthModeEnabled(bool $restricted_bandwidth_mode_enabled) : $this
Parameters
$restricted_bandwidth_mode_enabled : bool

Disable features that require additional bandwidth such as Motion Recap. Can be either true or false. Defaults to false.

Return values
$this —

setScheduleId()

Sets schedule_id

public setScheduleId(string $schedule_id) : $this
Parameters
$schedule_id : string

Schedule for which this camera will record video, or 'null' to always record.

Return values
$this —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results