Dimension Class

  • java.lang.Object
    • com.azure.resourcemanager.webpubsub.models.Dimension

Implements

public final class Dimension
implements JsonSerializable<Dimension>

Specifications of the Dimension of metrics.

Constructor Summary

Constructor Description
Dimension()

Creates an instance of Dimension class.

Method Summary

Modifier and Type Method and Description
String displayName()

Get the displayName property: Localized friendly display name of the dimension.

static Dimension fromJson(JsonReader jsonReader)

Reads an instance of Dimension from the JsonReader.

String internalName()

Get the internalName property: Name of the dimension as it appears in MDM.

String name()

Get the name property: The public facing name of the dimension.

Boolean toBeExportedForShoebox()

Get the toBeExportedForShoebox property: A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

Dimension withDisplayName(String displayName)

Set the displayName property: Localized friendly display name of the dimension.

Dimension withInternalName(String internalName)

Set the internalName property: Name of the dimension as it appears in MDM.

Dimension withName(String name)

Set the name property: The public facing name of the dimension.

Dimension withToBeExportedForShoebox(Boolean toBeExportedForShoebox)

Set the toBeExportedForShoebox property: A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.

Methods inherited from java.lang.Object

Constructor Details

Dimension

public Dimension()

Creates an instance of Dimension class.

Method Details

displayName

public String displayName()

Get the displayName property: Localized friendly display name of the dimension.

Returns:

the displayName value.

fromJson

public static Dimension fromJson(JsonReader jsonReader)

Reads an instance of Dimension from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

internalName

public String internalName()

Get the internalName property: Name of the dimension as it appears in MDM.

Returns:

the internalName value.

name

public String name()

Get the name property: The public facing name of the dimension.

Returns:

the name value.

toBeExportedForShoebox

public Boolean toBeExportedForShoebox()

Get the toBeExportedForShoebox property: A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.

Returns:

the toBeExportedForShoebox value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withDisplayName

public Dimension withDisplayName(String displayName)

Set the displayName property: Localized friendly display name of the dimension.

Parameters:

displayName - the displayName value to set.

Returns:

the Dimension object itself.

withInternalName

public Dimension withInternalName(String internalName)

Set the internalName property: Name of the dimension as it appears in MDM.

Parameters:

internalName - the internalName value to set.

Returns:

the Dimension object itself.

withName

public Dimension withName(String name)

Set the name property: The public facing name of the dimension.

Parameters:

name - the name value to set.

Returns:

the Dimension object itself.

withToBeExportedForShoebox

public Dimension withToBeExportedForShoebox(Boolean toBeExportedForShoebox)

Set the toBeExportedForShoebox property: A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.

Parameters:

toBeExportedForShoebox - the toBeExportedForShoebox value to set.

Returns:

the Dimension object itself.

Applies to