ParameterExampleContract Class

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.5

• java.lang.Object
• • com.azure.resourcemanager.apimanagement.models.ParameterExampleContract

Implements

JsonSerializable<ParameterExampleContract>

public final class ParameterExampleContract
implements JsonSerializable<ParameterExampleContract>

Parameter example.

Constructor Summary

Constructor	Description
ParameterExampleContract()	Creates an instance of ParameterExampleContract class.

Method Summary

Modifier and Type	Method and Description
String	description() Get the description property: Long description for the example.
String	externalValue() Get the externalValue property: A URL that points to the literal example.
static ParameterExampleContract	fromJson(JsonReader jsonReader) Reads an instance of ParameterExampleContract from the JsonReader.
String	summary() Get the summary property: Short description for the example.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
Object	value() Get the value property: Example value.
ParameterExampleContract	withDescription(String description) Set the description property: Long description for the example.
ParameterExampleContract	withExternalValue(String externalValue) Set the externalValue property: A URL that points to the literal example.
ParameterExampleContract	withSummary(String summary) Set the summary property: Short description for the example.
ParameterExampleContract	withValue(Object value) Set the value property: Example value.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ParameterExampleContract

public ParameterExampleContract()

Creates an instance of ParameterExampleContract class.

Method Details

description

public String description()

Get the description property: Long description for the example.

Returns:

the description value.

externalValue

public String externalValue()

Get the externalValue property: A URL that points to the literal example.

Returns:

the externalValue value.

fromJson

public static ParameterExampleContract fromJson(JsonReader jsonReader)

Reads an instance of ParameterExampleContract from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

summary

public String summary()

Get the summary property: Short description for the example.

Returns:

the summary value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

value

public Object value()

Get the value property: Example value. May be a primitive value, or an object.

Returns:

the value value.

withDescription

public ParameterExampleContract withDescription(String description)

Set the description property: Long description for the example.

Parameters:

description - the description value to set.

Returns:

the ParameterExampleContract object itself.

withExternalValue

public ParameterExampleContract withExternalValue(String externalValue)

Set the externalValue property: A URL that points to the literal example.

Parameters:

externalValue - the externalValue value to set.

Returns:

the ParameterExampleContract object itself.

withSummary

public ParameterExampleContract withSummary(String summary)

Set the summary property: Short description for the example.

Parameters:

summary - the summary value to set.

Returns:

the ParameterExampleContract object itself.

withValue

public ParameterExampleContract withValue(Object value)

Set the value property: Example value. May be a primitive value, or an object.

Parameters:

value - the value value to set.

Returns:

the ParameterExampleContract object itself.