addGeolocationUpdateImmediate

The addGeolocationUpdateImmediate operation handles configuration related to GeolocationUpdateImmediate model.

Data Parameters

Parameter	Required	Type	Description
scheduleType	False	string	A mandatory enum value that specifies the type of job schedule. Only allowed value is: IMMEDIATE - the job will be posted when the request is received. Note that the job will be posted in the queue when it is received, but the actual execution can be delayed if other jobs were scheduled for execution at the same time or are being currently processed. After a system restart the job will not be recovered.
user	False	string	System provided ID of the user who scheduled the job. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
forceOperation	False	boolean	For Internal use.
jobHistoryUuid	False	string	For Internal use. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
ipAddress	False	string	IP address of actor who initiated a job execution Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
name	False	string	A String containing the user provided identifier associated with a scheduled activity. Field level constraints: length must be between 0 and 32 (inclusive), must match pattern ^[a-zA-Z0-9][a-zA-Z0-9_+-]*$. (Note: Additional constraints might exist)
description	False	string	An optional String value containing description about the Geolocaiton update activity. Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
jobName	False	string	See derived class.
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

- name: Execute 'addGeolocationUpdateImmediate' operation
  ftd_configuration:
    operation: "addGeolocationUpdateImmediate"
    data:
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        ipAddress: "{{ ip_address }}"
        name: "{{ name }}"
        description: "{{ description }}"
        jobName: "{{ job_name }}"
        type: "{{ type }}"