Package com.azure.resourcemanager.network.fluent.models

Class PacketCaptureResultProperties

java.lang.Object

com.azure.resourcemanager.network.fluent.models.PacketCaptureParameters

com.azure.resourcemanager.network.fluent.models.PacketCaptureResultProperties

All Implemented Interfaces:

com.azure.json.JsonSerializable<PacketCaptureParameters>

public final class PacketCaptureResultProperties
extends PacketCaptureParameters

The properties of a packet capture session.

Constructor Summary

Constructors

Constructor	Description
PacketCaptureResultProperties()	Creates an instance of PacketCaptureResultProperties class.

Method Summary

Modifier and Type	Method	Description
static PacketCaptureResultProperties	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of PacketCaptureResultProperties from the JsonReader.
ProvisioningState	provisioningState()	Get the provisioningState property: The provisioning state of the packet capture session.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)
void	validate()	Validates the instance.
PacketCaptureResultProperties	withBytesToCapturePerPacket(Long bytesToCapturePerPacket)	Set the bytesToCapturePerPacket property: Number of bytes captured per packet, the remaining bytes are truncated.
PacketCaptureResultProperties	withCaptureSettings(PacketCaptureSettings captureSettings)	Set the captureSettings property: The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
PacketCaptureResultProperties	withContinuousCapture(Boolean continuousCapture)	Set the continuousCapture property: This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value.
PacketCaptureResultProperties	withFilters(List<PacketCaptureFilter> filters)	Set the filters property: A list of packet capture filters.
PacketCaptureResultProperties	withScope(PacketCaptureMachineScope scope)	Set the scope property: A list of AzureVMSS instances which can be included or excluded to run packet capture.
PacketCaptureResultProperties	withStorageLocation(PacketCaptureStorageLocation storageLocation)	Set the storageLocation property: The storage location for a packet capture session.
PacketCaptureResultProperties	withTarget(String target)	Set the target property: The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
PacketCaptureResultProperties	withTargetType(PacketCaptureTargetType targetType)	Set the targetType property: Target type of the resource provided.
PacketCaptureResultProperties	withTimeLimitInSeconds(Integer timeLimitInSeconds)	Set the timeLimitInSeconds property: Maximum duration of the capture session in seconds.
PacketCaptureResultProperties	withTotalBytesPerSession(Long totalBytesPerSession)	Set the totalBytesPerSession property: Maximum size of the capture output.

Methods inherited from class com.azure.resourcemanager.network.fluent.models.PacketCaptureParameters

bytesToCapturePerPacket, captureSettings, continuousCapture, filters, scope, storageLocation, target, targetType, timeLimitInSeconds, totalBytesPerSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

PacketCaptureResultProperties

public PacketCaptureResultProperties()

Creates an instance of PacketCaptureResultProperties class.

Method Details

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the packet capture session.

Returns:

the provisioningState value.

withTarget

public PacketCaptureResultProperties withTarget(String target)

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

Overrides:

withTarget in class PacketCaptureParameters

Parameters:

target - the target value to set.

Returns:

the PacketCaptureParameters object itself.

withScope

public PacketCaptureResultProperties 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.

Overrides:

withScope in class PacketCaptureParameters

Parameters:

scope - the scope value to set.

Returns:

the PacketCaptureParameters object itself.

withTargetType

public PacketCaptureResultProperties withTargetType(PacketCaptureTargetType targetType)

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

Overrides:

withTargetType in class PacketCaptureParameters

Parameters:

targetType - the targetType value to set.

Returns:

the PacketCaptureParameters object itself.

withBytesToCapturePerPacket

public PacketCaptureResultProperties withBytesToCapturePerPacket(Long bytesToCapturePerPacket)

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

Overrides:

withBytesToCapturePerPacket in class PacketCaptureParameters

Parameters:

bytesToCapturePerPacket - the bytesToCapturePerPacket value to set.

Returns:

the PacketCaptureParameters object itself.

withTotalBytesPerSession

public PacketCaptureResultProperties withTotalBytesPerSession(Long totalBytesPerSession)

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

Overrides:

withTotalBytesPerSession in class PacketCaptureParameters

Parameters:

totalBytesPerSession - the totalBytesPerSession value to set.

Returns:

the PacketCaptureParameters object itself.

withTimeLimitInSeconds

public PacketCaptureResultProperties withTimeLimitInSeconds(Integer timeLimitInSeconds)

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

Overrides:

withTimeLimitInSeconds in class PacketCaptureParameters

Parameters:

timeLimitInSeconds - the timeLimitInSeconds value to set.

Returns:

the PacketCaptureParameters object itself.

withStorageLocation

public PacketCaptureResultProperties withStorageLocation(PacketCaptureStorageLocation storageLocation)

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

Overrides:

withStorageLocation in class PacketCaptureParameters

Parameters:

storageLocation - the storageLocation value to set.

Returns:

the PacketCaptureParameters object itself.

withFilters

public PacketCaptureResultProperties withFilters(List<PacketCaptureFilter> filters)

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

Overrides:

withFilters in class PacketCaptureParameters

Parameters:

filters - the filters value to set.

Returns:

the PacketCaptureParameters object itself.

withContinuousCapture

public PacketCaptureResultProperties 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'.

Overrides:

withContinuousCapture in class PacketCaptureParameters

Parameters:

continuousCapture - the continuousCapture value to set.

Returns:

the PacketCaptureParameters object itself.

withCaptureSettings

public PacketCaptureResultProperties withCaptureSettings(PacketCaptureSettings captureSettings)

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

Overrides:

withCaptureSettings in class PacketCaptureParameters

Parameters:

captureSettings - the captureSettings value to set.

Returns:

the PacketCaptureParameters object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class PacketCaptureParameters

Throws:

IllegalArgumentException - thrown if the instance is not valid.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<PacketCaptureParameters>

Overrides:

toJson in class PacketCaptureParameters

Throws:

IOException

fromJson

public static PacketCaptureResultProperties fromJson(com.azure.json.JsonReader jsonReader)
                                              throws IOException

Reads an instance of PacketCaptureResultProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

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

IOException - If an error occurs while reading the PacketCaptureResultProperties.