OriginUpdatePropertiesParameters Class

Package:

com.azure.resourcemanager.cdn.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cdn:2.53.7

• java.lang.Object
• • com.azure.resourcemanager.cdn.fluent.models.OriginUpdatePropertiesParameters

Implements

JsonSerializable<OriginUpdatePropertiesParameters>

public class OriginUpdatePropertiesParameters
implements JsonSerializable<OriginUpdatePropertiesParameters>

The JSON object that contains the properties of the origin.

Constructor Summary

Constructor	Description
OriginUpdatePropertiesParameters()	Creates an instance of OriginUpdatePropertiesParameters class.

Method Summary

Modifier and Type	Method and Description
Boolean	enabled() Get the enabled property: Origin is enabled for load balancing or not.
static OriginUpdatePropertiesParameters	fromJson(JsonReader jsonReader) Reads an instance of OriginUpdatePropertiesParameters 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	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.
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.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
Integer	weight() Get the weight property: Weight of the origin in given origin group for load balancing.
OriginUpdatePropertiesParameters	withEnabled(Boolean enabled) Set the enabled property: Origin is enabled for load balancing or not.
OriginUpdatePropertiesParameters	withHostname(String hostname) Set the hostname property: The address of the origin.
OriginUpdatePropertiesParameters	withHttpPort(Integer httpPort) Set the httpPort property: The value of the HTTP port.
OriginUpdatePropertiesParameters	withHttpsPort(Integer httpsPort) Set the httpsPort property: The value of the HTTPS port.
OriginUpdatePropertiesParameters	withOriginHostHeader(String originHostHeader) Set the originHostHeader property: The host header value sent to the origin with each request.
OriginUpdatePropertiesParameters	withPriority(Integer priority) Set the priority property: Priority of origin in given origin group for load balancing.
OriginUpdatePropertiesParameters	withPrivateLinkAlias(String privateLinkAlias) Set the privateLinkAlias property: The Alias of the Private Link resource.
OriginUpdatePropertiesParameters	withPrivateLinkApprovalMessage(String privateLinkApprovalMessage) Set the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link.
OriginUpdatePropertiesParameters	withPrivateLinkLocation(String privateLinkLocation) Set the privateLinkLocation property: The location of the Private Link resource.
OriginUpdatePropertiesParameters	withPrivateLinkResourceId(String privateLinkResourceId) Set the privateLinkResourceId property: The Resource Id of the Private Link resource.
OriginUpdatePropertiesParameters	withWeight(Integer weight) Set the weight property: Weight of the origin in given origin group for load balancing.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

OriginUpdatePropertiesParameters

public OriginUpdatePropertiesParameters()

Creates an instance of OriginUpdatePropertiesParameters 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 OriginUpdatePropertiesParameters fromJson(JsonReader jsonReader)

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.

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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.