Data Object - QueryFilterBeginsWith

WSDL type
vmware.mirage.mit.query.QueryFilterBeginsWith
Extends
QueryFilter
Since
Mirage 5.1.0

Data Object Description

Specify that the field must begin with the specified value.

Data Object Properties

Properties

Name Type Description
FieldFilterField

The field of the filter to compare.
  • This property will be one of FilterField's enums :
    Value Description
    BASE_IMAGE_LAYER_ID

    Filter field of base image layer Id.
    • Expected filter value type is Id
    • Expected Id value type is int

    BASE_IMAGE_LAYER_IMAGEID

    Filter field of base layer or app layer ImageId.
    • Expected filter value type is ImageId

    Since Mirage 5.3.0
    BASE_IMAGE_LAYER_NAME

    Filter field of base image layer name.
    • Expected filter value type is string

    BASE_IMAGE_LAYER_TYPE

    Filter field of base image layer type.
    • Expected filter value type is int

    COLLECTION_DESCRIPTION

    Filter field of description of collection.
    • Expected filter value type is string

    Since Mirage 5.3.0
    COLLECTION_ID

    Filter field of id of collection.
    • Expected filter value type is Id
    • Expected Id value type is int

    Since Mirage 5.3.0
    COLLECTION_NAME

    Filter field of name of collection.
    • Expected filter value type is string

    Since Mirage 5.3.0
    CVD_CLIENT_STATE

    Filter field of CVD's device status.
    • Expected filter value type is string
      This filter value should be one of the following strings :
      Value Description
      "Idle"Idle state.
      "PendingReboot"Pending reboot state.
      "ForceReboot"Force reboot state.
      "UploadInitializing"Upload initializing state.
      "Uploading"Uploading state.
      "RestorePrefetch"Restore prefetching states.
      "RestoreStreaming"Restore streaming states.
      "UpdateLayers"Downloading image states.
      "RebasePrefetching"Restore and base layer update prefetching states.
      "Migration"Migration states.
      "DriverLibraryUpdate"Driver library updating states.
      "RestoreUserData"Restore and profile prefetching states.
      "DeviceProvisioning"Device provisioning states.
      "AppLayerRecording"App layer recording states.
      "AppLayerCapture"App layer capture states.
      "Synchronizing"Synchronizing states.
      "PendingUpgrade"Pending upgrade states.
      "PendingRestore"Pending restore states.
      "PendingAssignment"Pending assignment states.
      "Suspended"Suspended states.
      "WaitingForService"Waiting for service states.
      "Throttled"Throttled states.
      "PendingUserAuthentication"Pending user authentication states.
      "Snoozed"Snoozed states.
      "BranchReflectorIsBusy"Branch reflector is busy states.
      "WaitingDeviceProvisioning"Waiting for device provisioning states.
      "RecordingAppLayer"Recording App Layer states.
      "NoPotentialBranchReflectors"No Potential Branch Reflectors states.
      "BranchReflectorIsCaching"Branch Reflector Is Caching states.
      "PendingGatewayLogin"Pending authentication from Gateway states.
      "PendingRebootStreaming"Pending reboot for restore streaming states.
      "RestoreInitializing"Restore initializing states.
      "UpdateLayersInitializing"Download image initializing states.
      "RebasePrefetchInitializing"Restore and base layer update initializing states.
      "MigrationInitializing"Migration initializing states.
      "DriverLibraryUpdateInitializing"Driver library update initializing states.
      "RestoreUserDataInitializing"Restore user data initializing states.
      "DeviceProvisoningInitializing"Device Provisioning initializing states.
      "AppLayerRecordingInitializing"App Layer recording initializing states.
      "AppLayerCaptureInitializing"App Layer capture initializing states.
      "SynchronizingInitializing"Synchronize initializing states.
      "RecordingAppLayerInitializing"Record App Layer initializing states.
      "RestoreStreamingInitializing"Restore streaming initializing states.
      "UploadChangesFinalizing"Upload changes finalizing states.
      "RestorePrefetchFinalizing"Restore prefetch finalizing states.
      "UpdateLayersFinalizing"Download image finalizing states.
      "RebasePrefetchFinalizing"Restore and base layer update prefetch finalizing states.
      "MigrationFinalizing"Migration finalizing states.
      "DriverLibraryUpdateFinalizing"Driver library update finalizing states.
      "RestoreUserDataFinalizing"Restore user data finalizing states.
      "DeviceProvisioningFinalizing"Device provisioning finalizing states.
      "AppLayerRecordingFinalizing"App Layer recording finalizing states.
      "AppLayerCaptureFinalizing"App Layer capture finalizing states.
      "RecordingAppLayerFinalizing"Recording App Layer finalizing states.
      "RestoreStreamingFinalizing"Restore streaming finalizing states.
      "SynchronizingFinalizing"Synchronizing finalizing states.

    Since Mirage 5.3.0
    CVD_DEVICE_CLIENT_STATUSDeprecated.

    Filter field of CVD's device status.
    • Expected filter value type is ClientState
      This filter value should be one of ClientState's enums :
      Value Description
      IdleIdle state.
      PendingRebootPending reboot state.
      ForceRebootForce reboot state.
      UploadInitializingUpload initializing state.
      UploadingUploading state.
      OthersOther client states.
      RestorePrefetchRestore prefetching states.

      Since Mirage 5.2.0
      RestoreStreamingRestore streaming states.

      Since Mirage 5.2.0
      UpdateLayersDownloading image states.

      Since Mirage 5.2.0
      RebasePrefetchingRestore and base layer update prefetching states.

      Since Mirage 5.2.0
      MigrationMigration states.

      Since Mirage 5.2.0
      DriverLibraryUpdateDriver library updating states.

      Since Mirage 5.2.0
      RestoreUserDataRestore and profile prefetching states.

      Since Mirage 5.2.0
      DeviceProvisioningDevice provisioning states.

      Since Mirage 5.2.0
      AppLayerRecordingApp layer recording states.

      Since Mirage 5.2.0
      AppLayerCaptureApp layer capture states.

      Since Mirage 5.2.0
      SynchronizingSynchronizing states.

      Since Mirage 5.2.0
      PendingUpgradePending upgrade states.

      Since Mirage 5.2.0
      PendingRestorePending restore states.

      Since Mirage 5.2.0
      PendingAssignmentPending assignment states.

      Since Mirage 5.2.0
      SuspendedSuspended states.

      Since Mirage 5.2.0
      WaitingForServiceWaiting for service states.

      Since Mirage 5.2.0
      ThrottledThrottled states.

      Since Mirage 5.2.0
      PendingUserAuthenticationPending user authentication states.

      Since Mirage 5.2.0
      SnoozedSnoozed states.

      Since Mirage 5.2.0
      BranchReflectorIsBusyBranch reflector is busy states.

      Since Mirage 5.2.0
      WaitingDeviceProvisioningWaiting for device provisioning states.

      Since Mirage 5.2.0
      RecordingAppLayerRecording App Layer states.

      Since Mirage 5.2.0
      NoPotentialBranchReflectorsNo Potential Branch Reflectors states.

      Since Mirage 5.2.0
      BranchReflectorIsCachingBranch Reflector Is Caching states.

      Since Mirage 5.2.0
      PendingGatewayLoginPending authentication from Gateway states.

      Since Mirage 5.2.0
      PendingRebootStreamingPending reboot for restore streaming states.

      Since Mirage 5.2.0
      RestoreInitializingRestore initializing states.

      Since Mirage 5.2.0
      UpdateLayersInitializingDownload image initializing states.

      Since Mirage 5.2.0
      RebasePrefetchInitializingRestore and base layer update initializing states.

      Since Mirage 5.2.0
      MigrationInitializingMigration initializing states.

      Since Mirage 5.2.0
      DriverLibraryUpdateInitializingDriver library update initializing states.

      Since Mirage 5.2.0
      RestoreUserDataInitializingRestore user data initializing states.

      Since Mirage 5.2.0
      DeviceProvisoningInitializingDevice Provisioning initializing states.

      Since Mirage 5.2.0
      AppLayerRecordingInitializingApp Layer recording initializing states.

      Since Mirage 5.2.0
      AppLayerCaptureInitializingApp Layer capture initializing states.

      Since Mirage 5.2.0
      SynchronizingInitializingSynchronize initailizing states.

      Since Mirage 5.2.0
      RecordingAppLayerInitializingRecord App Layer initializing states.

      Since Mirage 5.2.0
      RestoreStreamingInitializingRestore streaming initializing states.

      Since Mirage 5.2.0
      UploadChangesFinalizingUpload changes finalizing states.

      Since Mirage 5.2.0
      RestorePrefetchFinalizingRestore prefetch finalizing states.

      Since Mirage 5.2.0
      UpdateLayersFinalizingDownload image finalizing states.

      Since Mirage 5.2.0
      RebasePrefetchFinalizingRestore and base layer update prefetch finalizing states.

      Since Mirage 5.2.0
      MigrationFinalizingMigration finalizing states.

      Since Mirage 5.2.0
      DriverLibraryUpdateFinalizingDriver library update finalizing states.

      Since Mirage 5.2.0
      RestoreUserDataFinalizingRestore user data finalizing states.

      Since Mirage 5.2.0
      DeviceProvisioningFinalizingDevice provisioning finalizing states.

      Since Mirage 5.2.0
      AppLayerRecordingFinalizingApp Layer recording finalizing states.

      Since Mirage 5.2.0
      AppLayerCaptureFinalizingApp Layer capture finalizing states.

      Since Mirage 5.2.0
      RecordingAppLayerFinalizingRecording App Layer finalizing states.

      Since Mirage 5.2.0
      RestoreStreamingFinalizingRestore streaming finalizing states.

      Since Mirage 5.2.0
      SynchronizingFinalizingSynchronizing finalizing states.

      Since Mirage 5.2.0

    CVD_DEVICE_CONNECTION_STATE

    Filter field of CVD's device connection status.
    • Expected filter value type is boolean

    CVD_DEVICE_ID

    Filter field of CVD's containter Id.
    • Expected filter value type is Id
    • Expected Id value type is long
    • Filter value can be null

    CVD_DEVICE_OS

    Filter field of CVD's OS version.
    • Expected filter value type is string
      This filter value should be one of the following strings :
      Value Description
      "XP"Windows XP.
      "XP_EMBEDDED"Windows XP Embedded.
      "VISTA"Windows Vista x86.
      "VISTAX64"Windows Vista x64.
      "WIN7"Windows 7 x86.
      "WIN7_EMBEDDED"Windows 7 x86 Embedded.
      "WIN7X64"Windows 7 x64.
      "WIN7_EMBEDDEDX64"Windows 7 x64 Embedded.
      "WIN8_0"Windows 8 x86.
      "WIN8_0X64"Windows 8 x64.
      "WIN8_1"Windows 8.1 x86.
      "WIN8_1X64"Windows 8.1 x64.
      "WINPE"Windows PE 5.

    Since Mirage 5.3.0
    CVD_ID

    Filter field of CVD Id.
    • Expected filter value type is Id
    • Expected Id value type is long

    CVD_MACHINE_VERSION

    Filter field of CVD machine version.
    CVD_NAME

    Filter field of CVD name.
    • Expected filter value type is string

    CVD_POLICY_ID

    Filter field of CVD's policy Id.
    • Expected filter value type is Id
    • Expected Id value type is int

    CVD_POLICY_IMAGEID

    Filter field of CVD's policy ImageId.
    • Expected filter value type is ImageId

    Since Mirage 5.3.0
    CVD_POLICY_NAME

    Filter field of CVD policy name.
    • Expected filter value type is string

    CVD_PROGRESS

    Filter field of CVD operation progress.
    • Expected filter value type is long

    CVD_USER_NAME

    Filter field of CVD user name.
    • Expected filter value type is string

    DEVICE_CONNECTION_STATE

    Filter field of device connection status.
    • Expected filter value type is boolean

    DEVICE_ID

    Filter field of device Id.
    • Expected filter value type is Id
    • Expected Id value type is long

    DEVICE_MODEL_NAME

    Filter field of device's model name.
    • Expected filter value type is string

    DEVICE_NAME

    Filter field of device name.
    • Expected filter value type is string

    DEVICE_OS

    Filter field of device OS version.
    • Expected filter value type is string
      This filter value should be one of the following strings :
      Value Description
      "XP"Windows XP.
      "XP_EMBEDDED"Windows XP Embedded.
      "VISTA"Windows Vista x86.
      "VISTAX64"Windows Vista x64.
      "WIN7"Windows 7 x86.
      "WIN7_EMBEDDED"Windows 7 x86 Embedded.
      "WIN7X64"Windows 7 x64.
      "WIN7_EMBEDDEDX64"Windows 7 x64 Embedded.
      "WIN8_0"Windows 8 x86.
      "WIN8_0X64"Windows 8 x64.
      "WIN8_1"Windows 8.1 x86.
      "WIN8_1X64"Windows 8.1 x64.
      "WINPE"Windows PE 5.

    Since Mirage 5.3.0
    DEVICE_OS_VERSIONDeprecated.

    Filter field of device OS version.
    • Expected filter value type is OsVersion
      This filter value should be one of OsVersion's enums :
      Value Description
      OTHEROS unknown.
      WIN7Windows 7 x86.
      WIN7X64Windows 7 x64.
      XPWindows XP.
      VISTAWindows Vista x86.
      VISTAX64Windows Vista x64.
      WIN8Windows 8 x86.
      WIN8X64Windows 8 x64.
      XP_EMBEDDEDWindows XP Embedded.
      WIN8_1Windows 8.1 x86.
      WIN8_1X64Windows 8.1 x64.

    DEVICE_USER_NAME

    Filter field of device's user name.
    • Expected filter value type is string

    DEVICE_VENDOR_NAME

    Filter field of device's vendor name.
    • Expected filter value type is string

    DOWNLOAD_ONLY_MIGRATION_STATUS

    Filter field of download only migration status.
    • Expected filter value type is string
      This filter value should be one of the following strings :
      Value Description
      "Complete"Complete.
      "Failed"The migration is failed or cancelled.
      "Downloading"The migration is in progress.

    Since Mirage 5.3.0
    NULL

    Empty Filter field.
    POLICY_ID

    Filter field of policy Id.
    • Expected filter value type is Id
    • Expected Id value type is int

    POLICY_IMAGEID

    Filter field of policy ImageId
    • Expected filter value type is ImageId

    Since Mirage 5.3.0
    POLICY_NAME

    Filter field of policy name.
    • Expected filter value type is string

    VOLUME_ID

    Filter field of volume Id.
    • Expected filter value type is Id
    • Expected Id value type is int

    VOLUME_NAME

    Filter field of volume name.
    • Expected filter value type is string

    VOLUME_PATH

    Filter field of volume path.
    • Expected filter value type is string

Valueobject

The value that the field must begin with.
Properties inherited from QueryFilter
None

Show example