Package zowe.client.sdk.zoslogs.input

Class ZosLogParams.Builder

java.lang.Object

zowe.client.sdk.zoslogs.input.ZosLogParams.Builder

Enclosing class:

ZosLogParams

public static class ZosLogParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ZosLogParams	build()
ZosLogParams.Builder	direction(DirectionType direction)	Direction enum representing either forward or backward direction to retrieve log data from.
ZosLogParams.Builder	processResponses(boolean processResponses)	The z/OSMF Console API returns '\r' or '\r\n' where line-breaks.
ZosLogParams.Builder	startTime(String startTime)	Set the start time to retrieve log output from.
ZosLogParams.Builder	timeRange(String timeRange)	Time range of log retrieval.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public ZosLogParams build()

startTime

public ZosLogParams.Builder startTime(String startTime)

Set the start time to retrieve log output from.

The default value is the current UNIX timestamp on the server.

Parameters:

startTime - A String that represents either a DateTime in this format: YYYY-MM-DDTHH:MM:SSZ.

Returns:

ZosLogParams.Builder this object

See Also:

IBM Reference

direction

public ZosLogParams.Builder direction(DirectionType direction)

Direction enum representing either forward or backward direction to retrieve log data from.

The default is "backward," meaning that messages are retrieved backward from the specified time.

Parameters:

direction - DirectionType enum value.

Returns:

ZosLogParams.Builder this object

See Also:

IBM Reference

timeRange

public ZosLogParams.Builder timeRange(String timeRange)

Time range of log retrieval.

The default is 10m.

Parameters:

timeRange - range of log output to retrieve, the following are valid examples: 1s (one second), 10m (tem minutes), 24h (24 hours), etc.

Returns:

ZosLogParams.Builder this object

See Also:

IBM Reference

processResponses

public ZosLogParams.Builder processResponses(boolean processResponses)

The z/OSMF Console API returns '\r' or '\r\n' where line-breaks. Can attempt to replace these sequences with '\n', but there may be cases where that is not preferable. Specify false to prevent processing.

Default is false.

Parameters:

processResponses - true of false should message item be parsed for newline characters

Returns:

ZosLogParams.Builder this object