SecureString Class

Package:

com.azure.resourcemanager.synapse.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-synapse:1.0.0

• java.lang.Object
• • com.azure.resourcemanager.synapse.models.SecretBase
  • • com.azure.resourcemanager.synapse.models.SecureString

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.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Type of the secret.
void	validate() Validates the instance.
String	value() Get the value property: Value of secure string.
SecureString	withValue(String value) Set the value property: Value of secure string.

Methods inherited from SecretBase

fromJson toJson type validate

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SecureString.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Type of the secret.

Overrides:

SecureString.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

SecureString.validate()

value

public String value()

Get the value property: Value of secure string.

Returns:

the value value.

withValue

public SecureString withValue(String value)

Set the value property: Value of secure string.

Parameters:

value - the value value to set.

Returns:

the SecureString object itself.