TicketUserServices

<back to all web services

JobHeartbeatConfigureRequest

The following routes are available for this service:
PUT/JobHeartbeat/{JobName}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class JobHeartbeatConfigureRequest
    {
        public String jobName = null;
        public Integer expectedIntervalMinutes = null;
        public String description = null;
        public Boolean enabled = null;
        
        public String getJobName() { return jobName; }
        public JobHeartbeatConfigureRequest setJobName(String value) { this.jobName = value; return this; }
        public Integer getExpectedIntervalMinutes() { return expectedIntervalMinutes; }
        public JobHeartbeatConfigureRequest setExpectedIntervalMinutes(Integer value) { this.expectedIntervalMinutes = value; return this; }
        public String getDescription() { return description; }
        public JobHeartbeatConfigureRequest setDescription(String value) { this.description = value; return this; }
        public Boolean isEnabled() { return enabled; }
        public JobHeartbeatConfigureRequest setEnabled(Boolean value) { this.enabled = value; return this; }
    }

    public static class JobHeartbeatResult
    {
        public JobHeartbeat item = null;
        public Integer statusCode = null;
        public String message = null;
        
        public JobHeartbeat getItem() { return item; }
        public JobHeartbeatResult setItem(JobHeartbeat value) { this.item = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public JobHeartbeatResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getMessage() { return message; }
        public JobHeartbeatResult setMessage(String value) { this.message = value; return this; }
    }

    public static class JobHeartbeat
    {
        @StringLength(100)
        public String jobName = null;

        @StringLength(400)
        public String description = null;

        public Integer expectedIntervalMinutes = null;
        public Date lastRunAt = null;
        public Date lastOkAt = null;
        @StringLength(2147483647)
        public String lastResultJson = null;

        public Long itemsProcessed = null;
        public Integer consecutiveFailures = null;
        public Boolean enabled = null;
        public Date updatedAt = null;
        
        public String getJobName() { return jobName; }
        public JobHeartbeat setJobName(String value) { this.jobName = value; return this; }
        public String getDescription() { return description; }
        public JobHeartbeat setDescription(String value) { this.description = value; return this; }
        public Integer getExpectedIntervalMinutes() { return expectedIntervalMinutes; }
        public JobHeartbeat setExpectedIntervalMinutes(Integer value) { this.expectedIntervalMinutes = value; return this; }
        public Date getLastRunAt() { return lastRunAt; }
        public JobHeartbeat setLastRunAt(Date value) { this.lastRunAt = value; return this; }
        public Date getLastOkAt() { return lastOkAt; }
        public JobHeartbeat setLastOkAt(Date value) { this.lastOkAt = value; return this; }
        public String getLastResultJson() { return lastResultJson; }
        public JobHeartbeat setLastResultJson(String value) { this.lastResultJson = value; return this; }
        public Long getItemsProcessed() { return itemsProcessed; }
        public JobHeartbeat setItemsProcessed(Long value) { this.itemsProcessed = value; return this; }
        public Integer getConsecutiveFailures() { return consecutiveFailures; }
        public JobHeartbeat setConsecutiveFailures(Integer value) { this.consecutiveFailures = value; return this; }
        public Boolean isEnabled() { return enabled; }
        public JobHeartbeat setEnabled(Boolean value) { this.enabled = value; return this; }
        public Date getUpdatedAt() { return updatedAt; }
        public JobHeartbeat setUpdatedAt(Date value) { this.updatedAt = value; return this; }
    }

}

Java JobHeartbeatConfigureRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /JobHeartbeat/{JobName} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JobHeartbeatConfigureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Description>String</Description>
  <Enabled>false</Enabled>
  <ExpectedIntervalMinutes>0</ExpectedIntervalMinutes>
  <JobName>String</JobName>
</JobHeartbeatConfigureRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JobHeartbeatResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:ConsecutiveFailures>0</d2p1:ConsecutiveFailures>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Enabled>false</d2p1:Enabled>
    <d2p1:ExpectedIntervalMinutes>0</d2p1:ExpectedIntervalMinutes>
    <d2p1:ItemsProcessed>0</d2p1:ItemsProcessed>
    <d2p1:JobName>String</d2p1:JobName>
    <d2p1:LastOkAt>0001-01-01T00:00:00</d2p1:LastOkAt>
    <d2p1:LastResultJson>String</d2p1:LastResultJson>
    <d2p1:LastRunAt>0001-01-01T00:00:00</d2p1:LastRunAt>
    <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
  </Item>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</JobHeartbeatResult>