Share via

DataPlaneAadOrApiKeyAuthOption Class

  • Reference
Package:
com.azure.resourcemanager.search.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-search:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.search.models.DataPlaneAadOrApiKeyAuthOption

Implements

JsonSerializable<DataPlaneAadOrApiKeyAuthOption>

public final class DataPlaneAadOrApiKeyAuthOption
implements JsonSerializable<DataPlaneAadOrApiKeyAuthOption>

Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.

Constructor Summary

Constructor Description
DataPlaneAadOrApiKeyAuthOption()

Creates an instance of DataPlaneAadOrApiKeyAuthOption class.

Method Summary

Modifier and Type Method and Description
AadAuthFailureMode aadAuthFailureMode()

Get the aadAuthFailureMode property: Describes what response the data plane API of a search service would send for requests that failed authentication.
static DataPlaneAadOrApiKeyAuthOption fromJson(JsonReader jsonReader)

Reads an instance of DataPlaneAadOrApiKeyAuthOption from the JsonReader.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
DataPlaneAadOrApiKeyAuthOption withAadAuthFailureMode(AadAuthFailureMode aadAuthFailureMode)

Set the aadAuthFailureMode property: Describes what response the data plane API of a search service would send for requests that failed authentication.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataPlaneAadOrApiKeyAuthOption

public DataPlaneAadOrApiKeyAuthOption()

Creates an instance of DataPlaneAadOrApiKeyAuthOption class.

Method Details

aadAuthFailureMode

public AadAuthFailureMode aadAuthFailureMode()

Get the aadAuthFailureMode property: Describes what response the data plane API of a search service would send for requests that failed authentication.

Returns:

the aadAuthFailureMode value.

fromJson

public static DataPlaneAadOrApiKeyAuthOption fromJson(JsonReader jsonReader)

Reads an instance of DataPlaneAadOrApiKeyAuthOption from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DataPlaneAadOrApiKeyAuthOption 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 DataPlaneAadOrApiKeyAuthOption.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withAadAuthFailureMode

public DataPlaneAadOrApiKeyAuthOption withAadAuthFailureMode(AadAuthFailureMode aadAuthFailureMode)

Set the aadAuthFailureMode property: Describes what response the data plane API of a search service would send for requests that failed authentication.

Parameters:

aadAuthFailureMode - the aadAuthFailureMode value to set.

Returns:

the DataPlaneAadOrApiKeyAuthOption object itself.

Applies to