Class PushSettingsInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.appservice.models.ProxyOnlyResource
com.azure.resourcemanager.appservice.fluent.models.PushSettingsInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class PushSettingsInner extends ProxyOnlyResource
Push settings for the App.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PushSettingsInner()
    Creates an instance of PushSettingsInner 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 PushSettingsInner
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of PushSettingsInner from the JsonReader.
    String
    id()
    Get the id property: Fully qualified resource Id for the resource.
    Boolean
    isPushEnabled()
    Get the isPushEnabled property: Gets or sets a flag indicating whether the Push endpoint is enabled.
    String
    name()
    Get the name property: The name of the resource.
    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)
    String
    type()
    Get the type property: The type of the resource.
    void
    validate()
    Validates the instance.
    PushSettingsInner
    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.
    PushSettingsInner
    withIsPushEnabled(Boolean isPushEnabled)
    Set the isPushEnabled property: Gets or sets a flag indicating whether the Push endpoint is enabled.
    PushSettingsInner
    withKind(String kind)
    Set the kind property: Kind of resource.
    PushSettingsInner
    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.
    PushSettingsInner
    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 ProxyOnlyResource

    kind

    Methods inherited from class 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

    • PushSettingsInner

      public PushSettingsInner()
      Creates an instance of PushSettingsInner class.

  • Method Details

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class ProxyOnlyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class ProxyOnlyResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class ProxyOnlyResource
      Returns:
      the id value.

    • withKind

      public PushSettingsInner withKind(String kind)
      Set the kind property: Kind of resource.
      Overrides:
      withKind in class ProxyOnlyResource
      Parameters:
      kind - the kind value to set.
      Returns:
      the ProxyOnlyResource object itself.

    • 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 PushSettingsInner 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 PushSettingsInner 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 PushSettingsInner 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 PushSettingsInner 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 PushSettingsInner 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 PushSettingsInner 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 PushSettingsInner 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 PushSettingsInner object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ProxyOnlyResource
      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<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class ProxyOnlyResource
      Throws:
      IOException

    • fromJson

      public static PushSettingsInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PushSettingsInner from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PushSettingsInner 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 PushSettingsInner.