Package com.azure.resourcemanager.appservice.fluent.models

Class PushSettingsProperties

java.lang.Object
com.azure.resourcemanager.appservice.fluent.models.PushSettingsProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<PushSettingsProperties>
public final class PushSettingsProperties extends Object implements com.azure.json.JsonSerializable<PushSettingsProperties>
PushSettings resource specific properties.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PushSettingsProperties()
    Creates an instance of PushSettingsProperties class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    dynamicTagsJson()
    Get the dynamicTagsJson property: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
    static PushSettingsProperties
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of PushSettingsProperties from the JsonReader.
    boolean
    isPushEnabled()
    Get the isPushEnabled property: Gets or sets a flag indicating whether the Push endpoint is enabled.
    String
    tagsRequiringAuth()
    Get the tagsRequiringAuth property: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.
    String
    tagWhitelistJson()
    Get the tagWhitelistJson property: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    PushSettingsProperties
    withDynamicTagsJson(String dynamicTagsJson)
    Set the dynamicTagsJson property: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
    PushSettingsProperties
    withIsPushEnabled(boolean isPushEnabled)
    Set the isPushEnabled property: Gets or sets a flag indicating whether the Push endpoint is enabled.
    PushSettingsProperties
    withTagsRequiringAuth(String tagsRequiringAuth)
    Set the tagsRequiringAuth property: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.
    PushSettingsProperties
    withTagWhitelistJson(String tagWhitelistJson)
    Set the tagWhitelistJson property: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • PushSettingsProperties

      public PushSettingsProperties()
      Creates an instance of PushSettingsProperties class.

  • Method Details

    • isPushEnabled

      public boolean isPushEnabled()
      Get the isPushEnabled property: Gets or sets a flag indicating whether the Push endpoint is enabled.
      Returns:
      the isPushEnabled value.

    • withIsPushEnabled

      public PushSettingsProperties withIsPushEnabled(boolean isPushEnabled)
      Set the isPushEnabled property: Gets or sets a flag indicating whether the Push endpoint is enabled.
      Parameters:
      isPushEnabled - the isPushEnabled value to set.
      Returns:
      the PushSettingsProperties object itself.

    • tagWhitelistJson

      public String tagWhitelistJson()
      Get the tagWhitelistJson property: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
      Returns:
      the tagWhitelistJson value.

    • withTagWhitelistJson

      public PushSettingsProperties withTagWhitelistJson(String tagWhitelistJson)
      Set the tagWhitelistJson property: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
      Parameters:
      tagWhitelistJson - the tagWhitelistJson value to set.
      Returns:
      the PushSettingsProperties object itself.

    • tagsRequiringAuth

      public String tagsRequiringAuth()
      Get the tagsRequiringAuth property: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.
      Returns:
      the tagsRequiringAuth value.

    • withTagsRequiringAuth

      public PushSettingsProperties withTagsRequiringAuth(String tagsRequiringAuth)
      Set the tagsRequiringAuth property: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.
      Parameters:
      tagsRequiringAuth - the tagsRequiringAuth value to set.
      Returns:
      the PushSettingsProperties object itself.

    • dynamicTagsJson

      public String dynamicTagsJson()
      Get the dynamicTagsJson property: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
      Returns:
      the dynamicTagsJson value.

    • withDynamicTagsJson

      public PushSettingsProperties withDynamicTagsJson(String dynamicTagsJson)
      Set the dynamicTagsJson property: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
      Parameters:
      dynamicTagsJson - the dynamicTagsJson value to set.
      Returns:
      the PushSettingsProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<PushSettingsProperties>
      Throws:
      IOException

    • fromJson

      public static PushSettingsProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PushSettingsProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PushSettingsProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the PushSettingsProperties.