SecureString Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public final class SecureString
extends SecretBase

Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.

Constructor Summary

Constructor Description
SecureString()

Creates an instance of SecureString class.

Method Summary

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

Reads an instance of SecureString from the JsonReader.
String getType()

Get the type property: Type of the secret.
String getValue()

Get the value property: Value of secure string.
SecureString setValue(String value)

Set the value property: Value of secure string.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from SecretBase

fromJson getType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SecureString

public SecureString()

Creates an instance of SecureString class.

Method Details

fromJson

public static SecureString fromJson(JsonReader jsonReader)

Reads an instance of SecureString from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getType

public String getType()

Get the type property: Type of the secret.

Overrides:

SecureString.getType()

Returns:

the type value.

getValue

public String getValue()

Get the value property: Value of secure string.

Returns:

the value value.

setValue

public SecureString setValue(String value)

Set the value property: Value of secure string.

Parameters:

value - the value value to set.

Returns:

the SecureString object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SecureString.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to