PacketCaptureParameters Class

Package:
com.azure.resourcemanager.network.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-network:2.59.0
  • java.lang.Object
    • com.azure.resourcemanager.network.fluent.models.PacketCaptureParameters

Implements

JsonSerializable<PacketCaptureParameters>

public class PacketCaptureParameters
implements JsonSerializable<PacketCaptureParameters>

Parameters that define the create packet capture operation.

Constructor Summary

Constructor Description
PacketCaptureParameters()

Creates an instance of PacketCaptureParameters class.

Method Summary

Modifier and Type Method and Description
Long bytesToCapturePerPacket()

Get the bytesToCapturePerPacket property: Number of bytes captured per packet, the remaining bytes are truncated.
PacketCaptureSettings captureSettings()

Get the captureSettings property: The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
Boolean continuousCapture()

Get the continuousCapture property: This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value.
List<PacketCaptureFilter> filters()

Get the filters property: A list of packet capture filters.
static PacketCaptureParameters fromJson(JsonReader jsonReader)

Reads an instance of PacketCaptureParameters from the JsonReader.
PacketCaptureMachineScope scope()

Get the scope property: A list of AzureVMSS instances which can be included or excluded to run packet capture.
PacketCaptureStorageLocation storageLocation()

Get the storageLocation property: The storage location for a packet capture session.
String target()

Get the target property: The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
PacketCaptureTargetType targetType()

Get the targetType property: Target type of the resource provided.
Integer timeLimitInSeconds()

Get the timeLimitInSeconds property: Maximum duration of the capture session in seconds.
JsonWriter toJson(JsonWriter jsonWriter)
Long totalBytesPerSession()

Get the totalBytesPerSession property: Maximum size of the capture output.
void validate()

Validates the instance.
PacketCaptureParameters withBytesToCapturePerPacket(Long bytesToCapturePerPacket)

Set the bytesToCapturePerPacket property: Number of bytes captured per packet, the remaining bytes are truncated.
PacketCaptureParameters withCaptureSettings(PacketCaptureSettings captureSettings)

Set the captureSettings property: The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
PacketCaptureParameters withContinuousCapture(Boolean continuousCapture)

Set the continuousCapture property: This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value.
PacketCaptureParameters withFilters(List<PacketCaptureFilter> filters)

Set the filters property: A list of packet capture filters.
PacketCaptureParameters withScope(PacketCaptureMachineScope scope)

Set the scope property: A list of AzureVMSS instances which can be included or excluded to run packet capture.
PacketCaptureParameters withStorageLocation(PacketCaptureStorageLocation storageLocation)

Set the storageLocation property: The storage location for a packet capture session.
PacketCaptureParameters withTarget(String target)

Set the target property: The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
PacketCaptureParameters withTargetType(PacketCaptureTargetType targetType)

Set the targetType property: Target type of the resource provided.
PacketCaptureParameters withTimeLimitInSeconds(Integer timeLimitInSeconds)

Set the timeLimitInSeconds property: Maximum duration of the capture session in seconds.
PacketCaptureParameters withTotalBytesPerSession(Long totalBytesPerSession)

Set the totalBytesPerSession property: Maximum size of the capture output.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PacketCaptureParameters

public PacketCaptureParameters()

Creates an instance of PacketCaptureParameters class.

Method Details

bytesToCapturePerPacket

public Long bytesToCapturePerPacket()

Get the bytesToCapturePerPacket property: Number of bytes captured per packet, the remaining bytes are truncated.

Returns:

the bytesToCapturePerPacket value.

captureSettings

public PacketCaptureSettings captureSettings()

Get the captureSettings property: The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.

Returns:

the captureSettings value.

continuousCapture

public Boolean continuousCapture()

Get the continuousCapture property: This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.

Returns:

the continuousCapture value.

filters

public List<PacketCaptureFilter> filters()

Get the filters property: A list of packet capture filters.

Returns:

the filters value.

fromJson

public static PacketCaptureParameters fromJson(JsonReader jsonReader)

Reads an instance of PacketCaptureParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PacketCaptureParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

scope

public PacketCaptureMachineScope scope()

Get the scope property: A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.

Returns:

the scope value.

storageLocation

public PacketCaptureStorageLocation storageLocation()

Get the storageLocation property: The storage location for a packet capture session.

Returns:

the storageLocation value.

target

public String target()

Get the target property: The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.

Returns:

the target value.

targetType

public PacketCaptureTargetType targetType()

Get the targetType property: Target type of the resource provided.

Returns:

the targetType value.

timeLimitInSeconds

public Integer timeLimitInSeconds()

Get the timeLimitInSeconds property: Maximum duration of the capture session in seconds.

Returns:

the timeLimitInSeconds value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

totalBytesPerSession

public Long totalBytesPerSession()

Get the totalBytesPerSession property: Maximum size of the capture output.

Returns:

the totalBytesPerSession value.

validate

public void validate()

Validates the instance.

withBytesToCapturePerPacket

public PacketCaptureParameters withBytesToCapturePerPacket(Long bytesToCapturePerPacket)

Set the bytesToCapturePerPacket property: Number of bytes captured per packet, the remaining bytes are truncated.

Parameters:

bytesToCapturePerPacket - the bytesToCapturePerPacket value to set.

Returns:

the PacketCaptureParameters object itself.

withCaptureSettings

public PacketCaptureParameters withCaptureSettings(PacketCaptureSettings captureSettings)

Set the captureSettings property: The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.

Parameters:

captureSettings - the captureSettings value to set.

Returns:

the PacketCaptureParameters object itself.

withContinuousCapture

public PacketCaptureParameters withContinuousCapture(Boolean continuousCapture)

Set the continuousCapture property: This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.

Parameters:

continuousCapture - the continuousCapture value to set.

Returns:

the PacketCaptureParameters object itself.

withFilters

public PacketCaptureParameters withFilters(List<PacketCaptureFilter> filters)

Set the filters property: A list of packet capture filters.

Parameters:

filters - the filters value to set.

Returns:

the PacketCaptureParameters object itself.

withScope

public PacketCaptureParameters withScope(PacketCaptureMachineScope scope)

Set the scope property: A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.

Parameters:

scope - the scope value to set.

Returns:

the PacketCaptureParameters object itself.

withStorageLocation

public PacketCaptureParameters withStorageLocation(PacketCaptureStorageLocation storageLocation)

Set the storageLocation property: The storage location for a packet capture session.

Parameters:

storageLocation - the storageLocation value to set.

Returns:

the PacketCaptureParameters object itself.

withTarget

public PacketCaptureParameters withTarget(String target)

Set the target property: The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.

Parameters:

target - the target value to set.

Returns:

the PacketCaptureParameters object itself.

withTargetType

public PacketCaptureParameters withTargetType(PacketCaptureTargetType targetType)

Set the targetType property: Target type of the resource provided.

Parameters:

targetType - the targetType value to set.

Returns:

the PacketCaptureParameters object itself.

withTimeLimitInSeconds

public PacketCaptureParameters withTimeLimitInSeconds(Integer timeLimitInSeconds)

Set the timeLimitInSeconds property: Maximum duration of the capture session in seconds.

Parameters:

timeLimitInSeconds - the timeLimitInSeconds value to set.

Returns:

the PacketCaptureParameters object itself.

withTotalBytesPerSession

public PacketCaptureParameters withTotalBytesPerSession(Long totalBytesPerSession)

Set the totalBytesPerSession property: Maximum size of the capture output.

Parameters:

totalBytesPerSession - the totalBytesPerSession value to set.

Returns:

the PacketCaptureParameters object itself.

Applies to