Package com.azure.resourcemanager.cdn.fluent.models

Class EndpointInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.core.management.Resource
com.azure.resourcemanager.cdn.fluent.models.EndpointInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class EndpointInner extends com.azure.core.management.Resource
CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format <endpointname>.azureedge.net.

  • Constructor Details

    • EndpointInner

      public EndpointInner()
      Creates an instance of EndpointInner class.

  • Method Details

    • systemData

      public com.azure.core.management.SystemData systemData()
      Get the systemData property: Read only system data.
      Returns:
      the systemData value.

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class com.azure.core.management.ProxyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class com.azure.core.management.ProxyResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class com.azure.core.management.ProxyResource
      Returns:
      the id value.

    • withLocation

      public EndpointInner withLocation(String location)
      Overrides:
      withLocation in class com.azure.core.management.Resource

    • withTags

      public EndpointInner withTags(Map<String,String> tags)
      Overrides:
      withTags in class com.azure.core.management.Resource

    • 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 EndpointInner 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 EndpointInner 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 EndpointInner 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 EndpointInner 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.

    • originPath

      public String originPath()
      Get the originPath property: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
      Returns:
      the originPath value.

    • withOriginPath

      public EndpointInner 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.
      Parameters:
      originPath - the originPath value to set.
      Returns:
      the EndpointInner object itself.

    • contentTypesToCompress

      public List<String> contentTypesToCompress()
      Get the contentTypesToCompress property: List of content types on which compression applies. The value should be a valid MIME type.
      Returns:
      the contentTypesToCompress value.

    • withContentTypesToCompress

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

    • originHostHeader

      public String originHostHeader()
      Get 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.
      Returns:
      the originHostHeader value.

    • withOriginHostHeader

      public EndpointInner 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.
      Parameters:
      originHostHeader - the originHostHeader value to set.
      Returns:
      the EndpointInner object itself.

    • isCompressionEnabled

      public Boolean isCompressionEnabled()
      Get 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.
      Returns:
      the isCompressionEnabled value.

    • withIsCompressionEnabled

      public EndpointInner 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.
      Parameters:
      isCompressionEnabled - the isCompressionEnabled value to set.
      Returns:
      the EndpointInner object itself.

    • isHttpAllowed

      public Boolean isHttpAllowed()
      Get 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.
      Returns:
      the isHttpAllowed value.

    • withIsHttpAllowed

      public EndpointInner 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.
      Parameters:
      isHttpAllowed - the isHttpAllowed value to set.
      Returns:
      the EndpointInner object itself.

    • isHttpsAllowed

      public Boolean isHttpsAllowed()
      Get 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.
      Returns:
      the isHttpsAllowed value.

    • withIsHttpsAllowed

      public EndpointInner 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.
      Parameters:
      isHttpsAllowed - the isHttpsAllowed value to set.
      Returns:
      the EndpointInner object itself.

    • queryStringCachingBehavior

      public QueryStringCachingBehavior queryStringCachingBehavior()
      Get 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.
      Returns:
      the queryStringCachingBehavior value.

    • withQueryStringCachingBehavior

      public EndpointInner 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.
      Parameters:
      queryStringCachingBehavior - the queryStringCachingBehavior value to set.
      Returns:
      the EndpointInner object itself.

    • optimizationType

      public OptimizationType optimizationType()
      Get 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.
      Returns:
      the optimizationType value.

    • withOptimizationType

      public EndpointInner 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.
      Parameters:
      optimizationType - the optimizationType value to set.
      Returns:
      the EndpointInner object itself.

    • probePath

      public String probePath()
      Get 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.
      Returns:
      the probePath value.

    • withProbePath

      public EndpointInner 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.
      Parameters:
      probePath - the probePath value to set.
      Returns:
      the EndpointInner object itself.

    • geoFilters

      public List<GeoFilter> geoFilters()
      Get 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/.
      Returns:
      the geoFilters value.

    • withGeoFilters

      public EndpointInner 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/.
      Parameters:
      geoFilters - the geoFilters value to set.
      Returns:
      the EndpointInner object itself.

    • defaultOriginGroup

      public ResourceReference defaultOriginGroup()
      Get the defaultOriginGroup property: A reference to the origin group.
      Returns:
      the defaultOriginGroup value.

    • withDefaultOriginGroup

      public EndpointInner withDefaultOriginGroup(ResourceReference defaultOriginGroup)
      Set the defaultOriginGroup property: A reference to the origin group.
      Parameters:
      defaultOriginGroup - the defaultOriginGroup value to set.
      Returns:
      the EndpointInner object itself.

    • urlSigningKeys

      public List<UrlSigningKey> urlSigningKeys()
      Get the urlSigningKeys property: List of keys used to validate the signed URL hashes.
      Returns:
      the urlSigningKeys value.

    • withUrlSigningKeys

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

    • deliveryPolicy

      public EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy()
      Get the deliveryPolicy property: A policy that specifies the delivery rules to be used for an endpoint.
      Returns:
      the deliveryPolicy value.

    • withDeliveryPolicy

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

    • webApplicationFirewallPolicyLink

      public EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink()
      Get the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for the endpoint (if applicable).
      Returns:
      the webApplicationFirewallPolicyLink value.

    • withWebApplicationFirewallPolicyLink

      public EndpointInner withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)
      Set the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for the endpoint (if applicable).
      Parameters:
      webApplicationFirewallPolicyLink - the webApplicationFirewallPolicyLink value to set.
      Returns:
      the EndpointInner 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<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class com.azure.core.management.Resource
      Throws:
      IOException

    • fromJson

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