ScriptSecureStringExecutionParameter Class

public final class ScriptSecureStringExecutionParameter
extends ScriptExecutionParameter

a plain text value execution parameter.

Constructor Summary

Constructor Description
ScriptSecureStringExecutionParameter()

Creates an instance of ScriptSecureStringExecutionParameter class.

Method Summary

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

Reads an instance of ScriptSecureStringExecutionParameter from the JsonReader.

String secureValue()

Get the secureValue property: A secure value for the passed parameter, not to be stored in logs.

JsonWriter toJson(JsonWriter jsonWriter)
ScriptExecutionParameterType type()

Get the type property: script execution parameter type.

void validate()

Validates the instance.

ScriptSecureStringExecutionParameter withName(String name)

Set the name property: The parameter name.

ScriptSecureStringExecutionParameter withSecureValue(String secureValue)

Set the secureValue property: A secure value for the passed parameter, not to be stored in logs.

Methods inherited from ScriptExecutionParameter

Methods inherited from java.lang.Object

Constructor Details

ScriptSecureStringExecutionParameter

public ScriptSecureStringExecutionParameter()

Creates an instance of ScriptSecureStringExecutionParameter class.

Method Details

fromJson

public static ScriptSecureStringExecutionParameter fromJson(JsonReader jsonReader)

Reads an instance of ScriptSecureStringExecutionParameter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

secureValue

public String secureValue()

Get the secureValue property: A secure value for the passed parameter, not to be stored in logs.

Returns:

the secureValue value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ScriptSecureStringExecutionParameter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public ScriptExecutionParameterType type()

Get the type property: script execution parameter type.

Overrides:

ScriptSecureStringExecutionParameter.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ScriptSecureStringExecutionParameter.validate()

withName

public ScriptSecureStringExecutionParameter withName(String name)

Set the name property: The parameter name.

Overrides:

ScriptSecureStringExecutionParameter.withName(String name)

Parameters:

name

withSecureValue

public ScriptSecureStringExecutionParameter withSecureValue(String secureValue)

Set the secureValue property: A secure value for the passed parameter, not to be stored in logs.

Parameters:

secureValue - the secureValue value to set.

Returns:

the ScriptSecureStringExecutionParameter object itself.

Applies to