Class OriginUpdatePropertiesParameters

java.lang.Object
com.azure.resourcemanager.cdn.fluent.models.OriginUpdatePropertiesParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<OriginUpdatePropertiesParameters>
Direct Known Subclasses:
OriginProperties

public class OriginUpdatePropertiesParameters extends Object implements com.azure.json.JsonSerializable<OriginUpdatePropertiesParameters>
The JSON object that contains the properties of the origin.
  • Constructor Details

    • OriginUpdatePropertiesParameters

      public OriginUpdatePropertiesParameters()
      Creates an instance of OriginUpdatePropertiesParameters class.
  • Method Details

    • hostname

      public String hostname()
      Get the hostname property: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
      Returns:
      the hostname value.
    • withHostname

      public OriginUpdatePropertiesParameters withHostname(String hostname)
      Set the hostname property: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
      Parameters:
      hostname - the hostname value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • httpPort

      public Integer httpPort()
      Get the httpPort property: The value of the HTTP port. Must be between 1 and 65535.
      Returns:
      the httpPort value.
    • withHttpPort

      public OriginUpdatePropertiesParameters withHttpPort(Integer httpPort)
      Set the httpPort property: The value of the HTTP port. Must be between 1 and 65535.
      Parameters:
      httpPort - the httpPort value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • httpsPort

      public Integer httpsPort()
      Get the httpsPort property: The value of the HTTPS port. Must be between 1 and 65535.
      Returns:
      the httpsPort value.
    • withHttpsPort

      public OriginUpdatePropertiesParameters withHttpsPort(Integer httpsPort)
      Set the httpsPort property: The value of the HTTPS port. Must be between 1 and 65535.
      Parameters:
      httpsPort - the httpsPort value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • originHostHeader

      public String originHostHeader()
      Get the originHostHeader property: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
      Returns:
      the originHostHeader value.
    • withOriginHostHeader

      public OriginUpdatePropertiesParameters withOriginHostHeader(String originHostHeader)
      Set the originHostHeader property: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.
      Parameters:
      originHostHeader - the originHostHeader value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • priority

      public Integer priority()
      Get the priority property: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
      Returns:
      the priority value.
    • withPriority

      public OriginUpdatePropertiesParameters withPriority(Integer priority)
      Set the priority property: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.
      Parameters:
      priority - the priority value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • weight

      public Integer weight()
      Get the weight property: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
      Returns:
      the weight value.
    • withWeight

      public OriginUpdatePropertiesParameters withWeight(Integer weight)
      Set the weight property: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
      Parameters:
      weight - the weight value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • enabled

      public Boolean enabled()
      Get the enabled property: Origin is enabled for load balancing or not.
      Returns:
      the enabled value.
    • withEnabled

      public OriginUpdatePropertiesParameters withEnabled(Boolean enabled)
      Set the enabled property: Origin is enabled for load balancing or not.
      Parameters:
      enabled - the enabled value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • privateLinkAlias

      public String privateLinkAlias()
      Get the privateLinkAlias property: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'.
      Returns:
      the privateLinkAlias value.
    • withPrivateLinkAlias

      public OriginUpdatePropertiesParameters withPrivateLinkAlias(String privateLinkAlias)
      Set the privateLinkAlias property: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'.
      Parameters:
      privateLinkAlias - the privateLinkAlias value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • privateLinkResourceId

      public String privateLinkResourceId()
      Get the privateLinkResourceId property: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.
      Returns:
      the privateLinkResourceId value.
    • withPrivateLinkResourceId

      public OriginUpdatePropertiesParameters withPrivateLinkResourceId(String privateLinkResourceId)
      Set the privateLinkResourceId property: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.
      Parameters:
      privateLinkResourceId - the privateLinkResourceId value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • privateLinkLocation

      public String privateLinkLocation()
      Get the privateLinkLocation property: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.
      Returns:
      the privateLinkLocation value.
    • withPrivateLinkLocation

      public OriginUpdatePropertiesParameters withPrivateLinkLocation(String privateLinkLocation)
      Set the privateLinkLocation property: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.
      Parameters:
      privateLinkLocation - the privateLinkLocation value to set.
      Returns:
      the OriginUpdatePropertiesParameters object itself.
    • privateLinkApprovalMessage

      public String privateLinkApprovalMessage()
      Get the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link.
      Returns:
      the privateLinkApprovalMessage value.
    • withPrivateLinkApprovalMessage

      public OriginUpdatePropertiesParameters withPrivateLinkApprovalMessage(String privateLinkApprovalMessage)
      Set the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link.
      Parameters:
      privateLinkApprovalMessage - the privateLinkApprovalMessage value to set.
      Returns:
      the OriginUpdatePropertiesParameters 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<OriginUpdatePropertiesParameters>
      Throws:
      IOException
    • fromJson

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