Share via


Display Class

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

Implements

public final class Display
implements JsonSerializable<Display>

Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.

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: Gets or sets the description.

static Display fromJson(JsonReader jsonReader)

Reads an instance of Display from the JsonReader.

String operation()

Get the operation property: Gets or sets the operation.

String provider()

Get the provider property: Gets or sets the provider.

String resource()

Get the resource property: Gets or sets the resource.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

Display withDescription(String description)

Set the description property: Gets or sets the description.

Display withOperation(String operation)

Set the operation property: Gets or sets the operation.

Display withProvider(String provider)

Set the provider property: Gets or sets the provider.

Display withResource(String resource)

Set the resource property: Gets or sets the resource.

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: Gets or sets the description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views. Prescriptive guidance for namespace: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespace: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'.

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: Gets or sets the operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'.

Returns:

the operation value.

provider

public String provider()

Get the provider property: Gets or sets the provider. The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with "Microsoft" for 1st party services. e.g. "Microsoft Monitoring Insights" or "Microsoft Compute.".

Returns:

the provider value.

resource

public String resource()

Get the resource property: Gets or sets the resource. The localized friendly form of the resource related to this action/operation – it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent’s display.resource field) e.g. "Virtual Machines" or "Scheduler Job Collections", or "Virtual Machine VM Sizes" or "Scheduler Jobs".

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: Gets or sets the description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views. Prescriptive guidance for namespace: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespace: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'.

Parameters:

description - the description value to set.

Returns:

the Display object itself.

withOperation

public Display withOperation(String operation)

Set the operation property: Gets or sets the operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'.

Parameters:

operation - the operation value to set.

Returns:

the Display object itself.

withProvider

public Display withProvider(String provider)

Set the provider property: Gets or sets the provider. The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with "Microsoft" for 1st party services. e.g. "Microsoft Monitoring Insights" or "Microsoft Compute.".

Parameters:

provider - the provider value to set.

Returns:

the Display object itself.

withResource

public Display withResource(String resource)

Set the resource property: Gets or sets the resource. The localized friendly form of the resource related to this action/operation – it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent’s display.resource field) e.g. "Virtual Machines" or "Scheduler Job Collections", or "Virtual Machine VM Sizes" or "Scheduler Jobs".

Parameters:

resource - the resource value to set.

Returns:

the Display object itself.

Applies to