OriginGroupProperties 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.OriginGroupUpdatePropertiesParameters
  • • com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties

public final class OriginGroupProperties
extends OriginGroupUpdatePropertiesParameters

The JSON object that contains the properties of the origin group.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static OriginGroupProperties	fromJson(JsonReader jsonReader) Reads an instance of OriginGroupProperties from the JsonReader.
OriginGroupProvisioningState	provisioningState() Get the provisioningState property: Provisioning status of the origin group.
OriginGroupResourceState	resourceState() Get the resourceState property: Resource status of the origin group.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
OriginGroupProperties	withHealthProbeSettings(HealthProbeParameters healthProbeSettings) Set the healthProbeSettings property: Health probe settings to the origin that is used to determine the health of the origin.
OriginGroupProperties	withOrigins(List<ResourceReference> origins) Set the origins property: The source of the content being delivered via CDN within given origin group.
OriginGroupProperties	withResponseBasedOriginErrorDetectionSettings(ResponseBasedOriginErrorDetectionParameters responseBasedOriginErrorDetectionSettings) Set the responseBasedOriginErrorDetectionSettings property: The JSON object that contains the properties to determine origin health using real requests/responses.
OriginGroupProperties	withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes) Set the trafficRestorationTimeToHealedOrNewEndpointsInMinutes property: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added.

Methods inherited from OriginGroupUpdatePropertiesParameters

fromJson healthProbeSettings origins responseBasedOriginErrorDetectionSettings toJson trafficRestorationTimeToHealedOrNewEndpointsInMinutes validate withHealthProbeSettings withOrigins withResponseBasedOriginErrorDetectionSettings withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

OriginGroupProperties

public OriginGroupProperties()

Creates an instance of OriginGroupProperties class.

Method Details

fromJson

public static OriginGroupProperties fromJson(JsonReader jsonReader)

Reads an instance of OriginGroupProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OriginGroupProperties 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 OriginGroupProperties.

provisioningState

public OriginGroupProvisioningState provisioningState()

Get the provisioningState property: Provisioning status of the origin group.

Returns:

the provisioningState value.

resourceState

public OriginGroupResourceState resourceState()

Get the resourceState property: Resource status of the origin group.

Returns:

the resourceState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

OriginGroupProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

Overrides:

OriginGroupProperties.validate()

withHealthProbeSettings

public OriginGroupProperties withHealthProbeSettings(HealthProbeParameters healthProbeSettings)

Set the healthProbeSettings property: Health probe settings to the origin that is used to determine the health of the origin.

Overrides:

OriginGroupProperties.withHealthProbeSettings(HealthProbeParameters healthProbeSettings)

Parameters:

healthProbeSettings

withOrigins

public OriginGroupProperties withOrigins(List<ResourceReference> origins)

Set the origins property: The source of the content being delivered via CDN within given origin group.

Overrides:

OriginGroupProperties.withOrigins(List<ResourceReference> origins)

Parameters:

origins

withResponseBasedOriginErrorDetectionSettings

public OriginGroupProperties withResponseBasedOriginErrorDetectionSettings(ResponseBasedOriginErrorDetectionParameters responseBasedOriginErrorDetectionSettings)

Set the responseBasedOriginErrorDetectionSettings property: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

Overrides:

OriginGroupProperties.withResponseBasedOriginErrorDetectionSettings(ResponseBasedOriginErrorDetectionParameters responseBasedOriginErrorDetectionSettings)

Parameters:

responseBasedOriginErrorDetectionSettings

withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes

public OriginGroupProperties withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes)

Set the trafficRestorationTimeToHealedOrNewEndpointsInMinutes property: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.

Overrides:

OriginGroupProperties.withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes)

Parameters:

trafficRestorationTimeToHealedOrNewEndpointsInMinutes