OriginGroupInner Class

Package:

com.azure.resourcemanager.cdn.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cdn:2.48.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.cdn.fluent.models.OriginGroupInner

public final class OriginGroupInner
extends ProxyResource

Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static OriginGroupInner	fromJson(JsonReader jsonReader) Reads an instance of OriginGroupInner from the JsonReader.
HealthProbeParameters	healthProbeSettings() Get the healthProbeSettings property: Health probe settings to the origin that is used to determine the health of the origin.
String	id() Get the id property: Fully qualified resource Id for the resource.
String	name() Get the name property: The name of the resource.
List<ResourceReference>	origins() Get the origins property: The source of the content being delivered via CDN within given origin group.
OriginGroupProvisioningState	provisioningState() Get the provisioningState property: Provisioning status of the origin group.
OriginGroupResourceState	resourceState() Get the resourceState property: Resource status of the origin group.
ResponseBasedOriginErrorDetectionParameters	responseBasedOriginErrorDetectionSettings() Get the responseBasedOriginErrorDetectionSettings property: The JSON object that contains the properties to determine origin health using real requests/responses.
SystemData	systemData() Get the systemData property: Read only system data.
JsonWriter	toJson(JsonWriter jsonWriter)
Integer	trafficRestorationTimeToHealedOrNewEndpointsInMinutes() Get 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.
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
OriginGroupInner	withHealthProbeSettings(HealthProbeParameters healthProbeSettings) Set the healthProbeSettings property: Health probe settings to the origin that is used to determine the health of the origin.
OriginGroupInner	withOrigins(List<ResourceReference> origins) Set the origins property: The source of the content being delivered via CDN within given origin group.
OriginGroupInner	withResponseBasedOriginErrorDetectionSettings(ResponseBasedOriginErrorDetectionParameters responseBasedOriginErrorDetectionSettings) Set the responseBasedOriginErrorDetectionSettings property: The JSON object that contains the properties to determine origin health using real requests/responses.
OriginGroupInner	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 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

OriginGroupInner

public OriginGroupInner()

Creates an instance of OriginGroupInner class.

Method Details

fromJson

public static OriginGroupInner fromJson(JsonReader jsonReader)

Reads an instance of OriginGroupInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

healthProbeSettings

public HealthProbeParameters healthProbeSettings()

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

Returns:

the healthProbeSettings value.

id

public String id()

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

Overrides:

OriginGroupInner.id()

Returns:

the id value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

OriginGroupInner.name()

Returns:

the name value.

origins

public List origins()

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

Returns:

the origins value.

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.

responseBasedOriginErrorDetectionSettings

public ResponseBasedOriginErrorDetectionParameters responseBasedOriginErrorDetectionSettings()

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

Returns:

the responseBasedOriginErrorDetectionSettings value.

systemData

public SystemData systemData()

Get the systemData property: Read only system data.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

OriginGroupInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

trafficRestorationTimeToHealedOrNewEndpointsInMinutes

public Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes()

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

Returns:

the trafficRestorationTimeToHealedOrNewEndpointsInMinutes value.

type

public String type()

Get the type property: The type of the resource.

Overrides:

OriginGroupInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withHealthProbeSettings

public OriginGroupInner withHealthProbeSettings(HealthProbeParameters healthProbeSettings)

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

Parameters:

healthProbeSettings - the healthProbeSettings value to set.

Returns:

the OriginGroupInner object itself.

withOrigins

public OriginGroupInner withOrigins(List origins)

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

Parameters:

origins - the origins value to set.

Returns:

the OriginGroupInner object itself.

withResponseBasedOriginErrorDetectionSettings

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

Parameters:

responseBasedOriginErrorDetectionSettings - the responseBasedOriginErrorDetectionSettings value to set.

Returns:

the OriginGroupInner object itself.

withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes

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

Parameters:

trafficRestorationTimeToHealedOrNewEndpointsInMinutes - the trafficRestorationTimeToHealedOrNewEndpointsInMinutes value to set.

Returns:

the OriginGroupInner object itself.