Share via


Display Class

  • java.lang.Object
    • com.azure.resourcemanager.azurestack.models.Display

Implements

public final class Display
implements JsonSerializable<Display>

Contains the localized display information for this particular operation or action.

Constructor Summary

Constructor Description
Display()

Creates an instance of Display class.

Method Summary

Modifier and Type Method and Description
String description()

Get the description property: The localized, friendly description for the operation.

static Display fromJson(JsonReader jsonReader)

Reads an instance of Display from the JsonReader.

String operation()

Get the operation property: The localized, friendly name for the operation.

String provider()

Get the provider property: The localized, friendly version of the resource provider name.

String resource()

Get the resource property: The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

Display withDescription(String description)

Set the description property: The localized, friendly description for the operation.

Display withOperation(String operation)

Set the operation property: The localized, friendly name for the operation.

Display withProvider(String provider)

Set the provider property: The localized, friendly version of the resource provider name.

Display withResource(String resource)

Set the resource property: The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.

Methods inherited from java.lang.Object

Constructor Details

Display

public Display()

Creates an instance of Display class.

Method Details

description

public String description()

Get the description property: The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views.

Returns:

the description value.

fromJson

public static Display fromJson(JsonReader jsonReader)

Reads an instance of Display from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

operation

public String operation()

Get the operation property: The localized, friendly name for the operation. Use the name as it will displayed to the user.

Returns:

the operation value.

provider

public String provider()

Get the provider property: The localized, friendly version of the resource provider name.

Returns:

the provider value.

resource

public String resource()

Get the resource property: The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.

Returns:

the resource value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withDescription

public Display withDescription(String description)

Set the description property: The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views.

Parameters:

description - the description value to set.

Returns:

the Display object itself.

withOperation

public Display withOperation(String operation)

Set the operation property: The localized, friendly name for the operation. Use the name as it will displayed to the user.

Parameters:

operation - the operation value to set.

Returns:

the Display object itself.

withProvider

public Display withProvider(String provider)

Set the provider property: The localized, friendly version of the resource provider name.

Parameters:

provider - the provider value to set.

Returns:

the Display object itself.

withResource

public Display withResource(String resource)

Set the resource property: The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.

Parameters:

resource - the resource value to set.

Returns:

the Display object itself.

Applies to