Package zowe.client.sdk.zoslogs.input

Class ZosLogParams.Builder

  • Enclosing class:
    ZosLogParams
    public static class ZosLogParams.Builder
extends Object
    Builder class for ZosLogParams

    • Constructor Detail

      • Builder

        public Builder()
        Builder constructor

    • Method Detail

      • 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:
        Builder this object

      • hardCopy

        public ZosLogParams.Builder hardCopy​(HardCopyType hardCopy)
        Set the z/OS log type (OPERLOG or SYSLOG) to retrieve log data from.

        If the hardcopy parameter is not specified, the API tries OPERLOG first. If the OPERLOG is not enabled on the system, the API returns the SYSLOG to the user.

        Parameters:
        hardCopy - HardCopyType enum value.
        Returns:
        Builder this object

      • 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:
        Builder this object

      • 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:
        Builder this object

      • 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 are not preferable. Specify false to prevent processing.

        Default is false.

        Parameters:
        processResponses - true of false should message item be parsed for newline characters
        Returns:
        Builder this object

      • build

        public ZosLogParams build()
        Return ZosLogParams object based on Builder this object
        Returns:
        ZosLogParams this object