Skip to content

New-PodeLogBatchInfo

SYNOPSIS

Create a new batch info object for logging.

SYNTAX

New-PodeLogBatchInfo [[-Size] <Int32>] [[-Timeout] <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Creates a new batch info object for logging, which can be used to configure batch processing of log items.

EXAMPLES

EXAMPLE 1

$batchInfo = New-PodeLogBatchInfo -Size 10 -Timeout 10

PARAMETERS

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Size

The number of log items to process in a single batch. (Default: 1)

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-Timeout

The maximum amount of time, in seconds, to wait before processing a batch of log items. (Default: 0, which means no timeout)

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Collections.Hashtable

NOTES