ConnectivityCheckSettings Class

  • java.lang.Object
    • com.azure.resourcemanager.network.models.ConnectivityCheckSettings

Implements

public final class ConnectivityCheckSettings
implements JsonSerializable<ConnectivityCheckSettings>

Settings that control how connectivity checks are performed by the connection analyzer.

Constructor Summary

Constructor Description
ConnectivityCheckSettings()

Creates an instance of ConnectivityCheckSettings class.

Method Summary

Modifier and Type Method and Description
static ConnectivityCheckSettings fromJson(JsonReader jsonReader)

Reads an instance of ConnectivityCheckSettings from the JsonReader.

Boolean generatePath()

Get the generatePath property: Whether to generate a hop-by-hop path during the connectivity check.

PreferredIpVersion preferredIPVersion()

Get the preferredIPVersion property: Preferred IP version for the connectivity check.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

ConnectivityCheckSettings withGeneratePath(Boolean generatePath)

Set the generatePath property: Whether to generate a hop-by-hop path during the connectivity check.

ConnectivityCheckSettings withPreferredIPVersion(PreferredIpVersion preferredIPVersion)

Set the preferredIPVersion property: Preferred IP version for the connectivity check.

Methods inherited from java.lang.Object

Constructor Details

ConnectivityCheckSettings

public ConnectivityCheckSettings()

Creates an instance of ConnectivityCheckSettings class.

Method Details

fromJson

public static ConnectivityCheckSettings fromJson(JsonReader jsonReader)

Reads an instance of ConnectivityCheckSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the ConnectivityCheckSettings.

generatePath

public Boolean generatePath()

Get the generatePath property: Whether to generate a hop-by-hop path during the connectivity check. Default value is true.

Returns:

the generatePath value.

preferredIPVersion

public PreferredIpVersion preferredIPVersion()

Get the preferredIPVersion property: Preferred IP version for the connectivity check.

Returns:

the preferredIPVersion value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withGeneratePath

public ConnectivityCheckSettings withGeneratePath(Boolean generatePath)

Set the generatePath property: Whether to generate a hop-by-hop path during the connectivity check. Default value is true.

Parameters:

generatePath - the generatePath value to set.

Returns:

the ConnectivityCheckSettings object itself.

withPreferredIPVersion

public ConnectivityCheckSettings withPreferredIPVersion(PreferredIpVersion preferredIPVersion)

Set the preferredIPVersion property: Preferred IP version for the connectivity check.

Parameters:

preferredIPVersion - the preferredIPVersion value to set.

Returns:

the ConnectivityCheckSettings object itself.

Applies to