Udostępnij za pośrednictwem


TakeSnapshotRequest Class

Definition

Request body for taking snapshot operation.

public class TakeSnapshotRequest
type TakeSnapshotRequest = class
Public Class TakeSnapshotRequest
Inheritance
TakeSnapshotRequest

Constructors

TakeSnapshotRequest()

Initializes a new instance of the TakeSnapshotRequest class.

TakeSnapshotRequest(SnapshotObjectType, String, IList<Guid>, String)

Initializes a new instance of the TakeSnapshotRequest class.

Properties

ApplyScope

Gets or sets user specified array of target Face subscription ids for the snapshot. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.

ObjectId

Gets or sets user specified source object id to take snapshot from.

Type

Gets or sets user specified type for the source object to take snapshot from. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported. Possible values include: 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'

UserData

Gets or sets user specified data about the snapshot for any purpose. Length should not exceed 16KB.

Methods

Validate()

Validate the object.

Applies to