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

Class PacketCaptureParameters

java.lang.Object
com.azure.resourcemanager.network.fluent.models.PacketCaptureParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<PacketCaptureParameters>
Direct Known Subclasses:
PacketCaptureResultProperties
public class PacketCaptureParameters extends Object implements com.azure.json.JsonSerializable<PacketCaptureParameters>
Parameters that define the create packet capture operation.

  • Constructor Details

    • PacketCaptureParameters

      public PacketCaptureParameters()
      Creates an instance of PacketCaptureParameters class.

  • Method Details

    • 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.

    • 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.

    • 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.

    • 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.

    • targetType

      public PacketCaptureTargetType targetType()
      Get the targetType property: Target type of the resource provided.
      Returns:
      the targetType value.

    • 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.

    • bytesToCapturePerPacket

      public Long bytesToCapturePerPacket()
      Get the bytesToCapturePerPacket property: Number of bytes captured per packet, the remaining bytes are truncated.
      Returns:
      the bytesToCapturePerPacket value.

    • 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.

    • totalBytesPerSession

      public Long totalBytesPerSession()
      Get the totalBytesPerSession property: Maximum size of the capture output.
      Returns:
      the totalBytesPerSession value.

    • 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.

    • timeLimitInSeconds

      public Integer timeLimitInSeconds()
      Get the timeLimitInSeconds property: Maximum duration of the capture session in seconds.
      Returns:
      the timeLimitInSeconds value.

    • 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.

    • storageLocation

      public PacketCaptureStorageLocation storageLocation()
      Get the storageLocation property: The storage location for a packet capture session.
      Returns:
      the storageLocation value.

    • 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.

    • filters

      public List<PacketCaptureFilter> filters()
      Get the filters property: A list of packet capture filters.
      Returns:
      the filters value.

    • 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.

    • 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.

    • 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.

    • captureSettings

      public PacketCaptureSettings captureSettings()
      Get the captureSettings property: The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
      Returns:
      the captureSettings value.

    • 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.

    • validate

      public void validate()
      Validates the instance.
      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>
      Throws:
      IOException

    • fromJson

      public static PacketCaptureParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the PacketCaptureParameters.