Share via

Display Class

Package:
com.microsoft.azure.management.resourcemover.v2021_01_01
Maven Artifact:
com.microsoft.azure.resourcemover.v2021_01_01:azure-mgmt-resourcemover:1.0.0
  • java.lang.Object
    • com.microsoft.azure.management.resourcemover.v2021_01_01.Display

public class 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()

Method Summary

Modifier and Type Method and Description
java.lang.String description()

Get gets or sets the description.
java.lang.String operation()

Get gets or sets the operation.
java.lang.String provider()

Get gets or sets the provider.
java.lang.String resource()

Get gets or sets the resource.
Display withDescription(String description)

Set gets or sets the description.
Display withOperation(String operation)

Set gets or sets the operation.
Display withProvider(String provider)

Set gets or sets the provider.
Display withResource(String resource)

Set gets or sets the resource.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

Display

public Display()

Method Details

description

public String description()

Get 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

operation

public String operation()

Get 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 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 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

withDescription

public Display withDescription(String description)

Set 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 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 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 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