Dela via

OriginInner Class

  • Reference
Package:
com.azure.resourcemanager.cdn.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cdn:2.48.0

public final class OriginInner
extends ProxyResource

CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

Constructor Summary

Constructor Description
OriginInner()

Creates an instance of OriginInner class.

Method Summary

Modifier and Type Method and Description
Boolean enabled()

Get the enabled property: Origin is enabled for load balancing or not.
static OriginInner fromJson(JsonReader jsonReader)

Reads an instance of OriginInner from the JsonReader.
String hostname()

Get the hostname property: The address of the origin.
Integer httpPort()

Get the httpPort property: The value of the HTTP port.
Integer httpsPort()

Get the httpsPort property: The value of the HTTPS port.
String id()

Get the id property: Fully qualified resource Id for the resource.
String name()

Get the name property: The name of the resource.
String originHostHeader()

Get the originHostHeader property: The host header value sent to the origin with each request.
Integer priority()

Get the priority property: Priority of origin in given origin group for load balancing.
PrivateEndpointStatus privateEndpointStatus()

Get the privateEndpointStatus property: The approval status for the connection to the Private Link.
String privateLinkAlias()

Get the privateLinkAlias property: The Alias of the Private Link resource.
String privateLinkApprovalMessage()

Get the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link.
String privateLinkLocation()

Get the privateLinkLocation property: The location of the Private Link resource.
String privateLinkResourceId()

Get the privateLinkResourceId property: The Resource Id of the Private Link resource.
OriginProvisioningState provisioningState()

Get the provisioningState property: Provisioning status of the origin.
OriginResourceState resourceState()

Get the resourceState property: Resource status of the origin.
SystemData systemData()

Get the systemData property: Read only system data.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
void validate()

Validates the instance.
Integer weight()

Get the weight property: Weight of the origin in given origin group for load balancing.
OriginInner withEnabled(Boolean enabled)

Set the enabled property: Origin is enabled for load balancing or not.
OriginInner withHostname(String hostname)

Set the hostname property: The address of the origin.
OriginInner withHttpPort(Integer httpPort)

Set the httpPort property: The value of the HTTP port.
OriginInner withHttpsPort(Integer httpsPort)

Set the httpsPort property: The value of the HTTPS port.
OriginInner withOriginHostHeader(String originHostHeader)

Set the originHostHeader property: The host header value sent to the origin with each request.
OriginInner withPriority(Integer priority)

Set the priority property: Priority of origin in given origin group for load balancing.
OriginInner withPrivateLinkAlias(String privateLinkAlias)

Set the privateLinkAlias property: The Alias of the Private Link resource.
OriginInner withPrivateLinkApprovalMessage(String privateLinkApprovalMessage)

Set the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link.
OriginInner withPrivateLinkLocation(String privateLinkLocation)

Set the privateLinkLocation property: The location of the Private Link resource.
OriginInner withPrivateLinkResourceId(String privateLinkResourceId)

Set the privateLinkResourceId property: The Resource Id of the Private Link resource.
OriginInner withWeight(Integer weight)

Set the weight property: Weight of the origin in given origin group for load balancing.

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

OriginInner

public OriginInner()

Creates an instance of OriginInner class.

Method Details

enabled

public Boolean enabled()

Get the enabled property: Origin is enabled for load balancing or not.

Returns:

the enabled value.

fromJson

public static OriginInner fromJson(JsonReader jsonReader)

Reads an instance of OriginInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OriginInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

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.

httpPort

public Integer httpPort()

Get the httpPort property: The value of the HTTP port. Must be between 1 and 65535.

Returns:

the httpPort value.

httpsPort

public Integer httpsPort()

Get the httpsPort property: The value of the HTTPS port. Must be between 1 and 65535.

Returns:

the httpsPort value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

OriginInner.id()

Returns:

the id value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

OriginInner.name()

Returns:

the name value.

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.

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.

privateEndpointStatus

public PrivateEndpointStatus privateEndpointStatus()

Get the privateEndpointStatus property: The approval status for the connection to the Private Link.

Returns:

the privateEndpointStatus value.

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.

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.

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.

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.

provisioningState

public OriginProvisioningState provisioningState()

Get the provisioningState property: Provisioning status of the origin.

Returns:

the provisioningState value.

resourceState

public OriginResourceState resourceState()

Get the resourceState property: Resource status of the origin.

Returns:

the resourceState value.

systemData

public SystemData systemData()

Get the systemData property: Read only system data.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

OriginInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

OriginInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

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.

withEnabled

public OriginInner withEnabled(Boolean enabled)

Set the enabled property: Origin is enabled for load balancing or not.

Parameters:

enabled - the enabled value to set.

Returns:

the OriginInner object itself.

withHostname

public OriginInner 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 OriginInner object itself.

withHttpPort

public OriginInner 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 OriginInner object itself.

withHttpsPort

public OriginInner 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 OriginInner object itself.

withOriginHostHeader

public OriginInner 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 OriginInner object itself.

withPriority

public OriginInner 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 OriginInner object itself.

withPrivateLinkAlias

public OriginInner 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 OriginInner object itself.

withPrivateLinkApprovalMessage

public OriginInner 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 OriginInner object itself.

withPrivateLinkLocation

public OriginInner 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 OriginInner object itself.

withPrivateLinkResourceId

public OriginInner 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 OriginInner object itself.

withWeight

public OriginInner 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 OriginInner object itself.

Applies to