Package zowe.client.sdk.zoslogs.response

Class ZosLogResponse

java.lang.Object

zowe.client.sdk.zoslogs.response.ZosLogResponse

public final class ZosLogResponse
extends Object

Standard log response document. Represents the details about the messages and logs.

Refactored as an immutable Jackson POJO without Optional or builder. Uses primitive long defaults for numeric fields when null.

Version:

5.0

Author:

Frank Giordano

Constructor Summary

Constructors

Constructor	Description
ZosLogResponse(Long timeZone, Long nextTimeStamp, String source, Long totalItems, List<ZosLogItem> items)	Jackson constructor for ZosLogResponse.

Method Summary

Modifier and Type	Method	Description
List<ZosLogItem>	getItems()	Retrieve the list of log items.
long	getNextTimeStamp()	Retrieve the next timestamp.
String	getSource()	Retrieve the source of the log.
long	getTimeZone()	Retrieve the timezone.
long	getTotalItems()	Retrieve the total number of items.
String	toString()	Return string value representing ZosLogResponse object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ZosLogResponse

public ZosLogResponse(Long timeZone,
                      Long nextTimeStamp,
                      String source,
                      Long totalItems,
                      List<ZosLogItem> items)

Jackson constructor for ZosLogResponse.

Parameters:

timeZone - Timezone value returned from response

nextTimeStamp - Next timestamp value returned from response

source - Source string value returned from response

totalItems - Total items count returned from response

items - List of ZosLogItem messages returned from response

Method Detail

getTimeZone

public long getTimeZone()

Retrieve the timezone.

Returns:

long value representing the timezone (0 if absent)

getNextTimeStamp

public long getNextTimeStamp()

Retrieve the next timestamp.

Returns:

long value representing the next timestamp (0 if absent)

getSource

public String getSource()

Retrieve the source of the log.

Returns:

source string

getTotalItems

public long getTotalItems()

Retrieve the total number of items.

Returns:

long total number of messages (0 if absent)

getItems

public List<ZosLogItem> getItems()

Retrieve the list of log items.

Returns:

list of ZosLogItem

toString

public String toString()

Return string value representing ZosLogResponse object.

Overrides:

toString in class Object

Returns:

string representation of ZosLogResponse