BatchStartedEvent

java.lang.Object
- com.suse.salt.netapi.event.BatchStartedEvent

public class BatchStartedEvent
extends java.lang.Object

Represents an event fired when a batch job starts.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BatchStartedEvent.Data
Data object of the batch started event

Field Summary

Fields
Modifier and Type	Field	Description
`private BatchStartedEvent.Data`	`data`
`private static com.google.gson.Gson`	`GSON`
`private java.lang.String`	`jobId`
`private static java.util.regex.Pattern`	`PATTERN`

Constructor Summary

Constructors
Constructor Description

BatchStartedEvent(java.lang.String jobIdIn, BatchStartedEvent.Data dataIn)
Creates a new BatchStartedEvent

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BatchStartedEvent.Data`	`getData()`
`java.lang.String`	`getJobId()`	The id of the job
`static java.util.Optional<BatchStartedEvent>`	`parse(Event event)`	Utility method to parse a generic event into a more specific one.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PATTERN

private static final java.util.regex.Pattern PATTERN

GSON

private static final com.google.gson.Gson GSON

jobId
```
private java.lang.String jobId
```

data
```
private BatchStartedEvent.Data data
```

Constructor Detail
- BatchStartedEvent
```
public BatchStartedEvent(java.lang.String jobIdIn,
                         BatchStartedEvent.Data dataIn)
```
  Creates a new BatchStartedEvent
  
  Parameters:
  
  jobIdIn - the id of the job
  
  dataIn - the data containing more information about this event

Method Detail
- getData
```
public BatchStartedEvent.Data getData()
```
  Returns:
  
  the event data
- getJobId
```
public java.lang.String getJobId()
```
  The id of the job
  
  Returns:
  
  job id
- parse
```
public static java.util.Optional<BatchStartedEvent> parse(Event event)
```
  Utility method to parse a generic event into a more specific one.
  
  Parameters:
  
  event - the generic event to parse
  
  Returns:
  
  an option containing the parsed value or non if it could not be parsed