BatchStartedEvent (salt-netapi-client 0.17.0 API)

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

```
public class BatchStartedEvent
extends 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

Constructor Summary

Constructors
Constructor Description

BatchStartedEvent(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()`
`String`	`getJobId()`	The id of the job
`static 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

- Constructor Detail
  - BatchStartedEvent
```
public BatchStartedEvent(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 String getJobId()
```
    The id of the job
    
    Returns:
    
    job id
  - parse
```
public static 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