Class EndpointProperties

java.lang.Object
com.azure.resourcemanager.cdn.fluent.models.EndpointPropertiesUpdateParameters
com.azure.resourcemanager.cdn.fluent.models.EndpointProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<EndpointPropertiesUpdateParameters>
public final class EndpointProperties extends EndpointPropertiesUpdateParameters
The JSON object that contains the properties required to create an endpoint.

  • Constructor Details

    • EndpointProperties

      public EndpointProperties()
      Creates an instance of EndpointProperties class.

  • Method Details

    • hostname

      public String hostname()
      Get the hostname property: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
      Returns:
      the hostname value.

    • origins

      public List<DeepCreatedOrigin> origins()
      Get the origins property: The source of the content being delivered via CDN.
      Returns:
      the origins value.

    • withOrigins

      public EndpointProperties withOrigins(List<DeepCreatedOrigin> origins)
      Set the origins property: The source of the content being delivered via CDN.
      Parameters:
      origins - the origins value to set.
      Returns:
      the EndpointProperties object itself.

    • originGroups

      public List<DeepCreatedOriginGroup> originGroups()
      Get the originGroups property: The origin groups comprising of origins that are used for load balancing the traffic based on availability.
      Returns:
      the originGroups value.

    • withOriginGroups

      public EndpointProperties withOriginGroups(List<DeepCreatedOriginGroup> originGroups)
      Set the originGroups property: The origin groups comprising of origins that are used for load balancing the traffic based on availability.
      Parameters:
      originGroups - the originGroups value to set.
      Returns:
      the EndpointProperties object itself.

    • customDomains

      public List<DeepCreatedCustomDomain> customDomains()
      Get the customDomains property: The custom domains under the endpoint.
      Returns:
      the customDomains value.

    • resourceState

      public EndpointResourceState resourceState()
      Get the resourceState property: Resource status of the endpoint.
      Returns:
      the resourceState value.

    • provisioningState

      public EndpointProvisioningState provisioningState()
      Get the provisioningState property: Provisioning status of the endpoint.
      Returns:
      the provisioningState value.

    • withOriginPath

      public EndpointProperties withOriginPath(String originPath)
      Set the originPath property: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
      Overrides:
      withOriginPath in class EndpointPropertiesUpdateParameters
      Parameters:
      originPath - the originPath value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withContentTypesToCompress

      public EndpointProperties withContentTypesToCompress(List<String> contentTypesToCompress)
      Set the contentTypesToCompress property: List of content types on which compression applies. The value should be a valid MIME type.
      Overrides:
      withContentTypesToCompress in class EndpointPropertiesUpdateParameters
      Parameters:
      contentTypesToCompress - the contentTypesToCompress value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withOriginHostHeader

      public EndpointProperties withOriginHostHeader(String originHostHeader)
      Set the originHostHeader property: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.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.
      Overrides:
      withOriginHostHeader in class EndpointPropertiesUpdateParameters
      Parameters:
      originHostHeader - the originHostHeader value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withIsCompressionEnabled

      public EndpointProperties withIsCompressionEnabled(Boolean isCompressionEnabled)
      Set the isCompressionEnabled property: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
      Overrides:
      withIsCompressionEnabled in class EndpointPropertiesUpdateParameters
      Parameters:
      isCompressionEnabled - the isCompressionEnabled value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withIsHttpAllowed

      public EndpointProperties withIsHttpAllowed(Boolean isHttpAllowed)
      Set the isHttpAllowed property: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
      Overrides:
      withIsHttpAllowed in class EndpointPropertiesUpdateParameters
      Parameters:
      isHttpAllowed - the isHttpAllowed value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withIsHttpsAllowed

      public EndpointProperties withIsHttpsAllowed(Boolean isHttpsAllowed)
      Set the isHttpsAllowed property: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
      Overrides:
      withIsHttpsAllowed in class EndpointPropertiesUpdateParameters
      Parameters:
      isHttpsAllowed - the isHttpsAllowed value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withQueryStringCachingBehavior

      public EndpointProperties withQueryStringCachingBehavior(QueryStringCachingBehavior queryStringCachingBehavior)
      Set the queryStringCachingBehavior property: Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
      Overrides:
      withQueryStringCachingBehavior in class EndpointPropertiesUpdateParameters
      Parameters:
      queryStringCachingBehavior - the queryStringCachingBehavior value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withOptimizationType

      public EndpointProperties withOptimizationType(OptimizationType optimizationType)
      Set the optimizationType property: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.
      Overrides:
      withOptimizationType in class EndpointPropertiesUpdateParameters
      Parameters:
      optimizationType - the optimizationType value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withProbePath

      public EndpointProperties withProbePath(String probePath)
      Set the probePath property: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
      Overrides:
      withProbePath in class EndpointPropertiesUpdateParameters
      Parameters:
      probePath - the probePath value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withGeoFilters

      public EndpointProperties withGeoFilters(List<GeoFilter> geoFilters)
      Set the geoFilters property: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
      Overrides:
      withGeoFilters in class EndpointPropertiesUpdateParameters
      Parameters:
      geoFilters - the geoFilters value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withDefaultOriginGroup

      public EndpointProperties withDefaultOriginGroup(ResourceReference defaultOriginGroup)
      Set the defaultOriginGroup property: A reference to the origin group.
      Overrides:
      withDefaultOriginGroup in class EndpointPropertiesUpdateParameters
      Parameters:
      defaultOriginGroup - the defaultOriginGroup value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withUrlSigningKeys

      public EndpointProperties withUrlSigningKeys(List<UrlSigningKey> urlSigningKeys)
      Set the urlSigningKeys property: List of keys used to validate the signed URL hashes.
      Overrides:
      withUrlSigningKeys in class EndpointPropertiesUpdateParameters
      Parameters:
      urlSigningKeys - the urlSigningKeys value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withDeliveryPolicy

      public EndpointProperties withDeliveryPolicy(EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy)
      Set the deliveryPolicy property: A policy that specifies the delivery rules to be used for an endpoint.
      Overrides:
      withDeliveryPolicy in class EndpointPropertiesUpdateParameters
      Parameters:
      deliveryPolicy - the deliveryPolicy value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • withWebApplicationFirewallPolicyLink

      public EndpointProperties withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)
      Set the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for the endpoint (if applicable).
      Overrides:
      withWebApplicationFirewallPolicyLink in class EndpointPropertiesUpdateParameters
      Parameters:
      webApplicationFirewallPolicyLink - the webApplicationFirewallPolicyLink value to set.
      Returns:
      the EndpointPropertiesUpdateParameters object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class EndpointPropertiesUpdateParameters
      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<EndpointPropertiesUpdateParameters>
      Overrides:
      toJson in class EndpointPropertiesUpdateParameters
      Throws:
      IOException

    • fromJson

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