azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.c...

254 строки
21 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner"
name: "AfdOriginGroupInner"
nameWithType: "AfdOriginGroupInner"
summary: "AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.core.management.ProxyResource?alt=com.azure.core.management.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.core.management.ProxyResource.fromJson(com.azure.json.JsonReader)?alt=com.azure.core.management.ProxyResource.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource.id()?alt=com.azure.core.management.ProxyResource.id&text=id\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource.name()?alt=com.azure.core.management.ProxyResource.name&text=name\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource.toJson(com.azure.json.JsonWriter)?alt=com.azure.core.management.ProxyResource.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource.type()?alt=com.azure.core.management.ProxyResource.type&text=type\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **AfdOriginGroupInner**</br> extends <xref href=\"com.azure.core.management.ProxyResource?alt=com.azure.core.management.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.AfdOriginGroupInner()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.AfdOriginGroupInner()"
name: "AfdOriginGroupInner()"
nameWithType: "AfdOriginGroupInner.AfdOriginGroupInner()"
summary: "Creates an instance of Afd<wbr>Origin<wbr>Group<wbr>Inner class."
syntax: "public AfdOriginGroupInner()"
desc: "Creates an instance of AfdOriginGroupInner class."
methods:
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.deploymentStatus()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.deploymentStatus()"
name: "deploymentStatus()"
nameWithType: "AfdOriginGroupInner.deploymentStatus()"
summary: "Get the deployment<wbr>Status property: The deployment<wbr>Status property."
syntax: "public DeploymentStatus deploymentStatus()"
desc: "Get the deploymentStatus property: The deploymentStatus property."
returns:
description: "the deploymentStatus value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.DeploymentStatus?alt=com.azure.resourcemanager.cdn.models.DeploymentStatus&text=DeploymentStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "AfdOriginGroupInner.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Afd<wbr>Origin<wbr>Group<wbr>Inner from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static AfdOriginGroupInner fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of AfdOriginGroupInner from the JsonReader."
returns:
description: "An instance of AfdOriginGroupInner if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner?alt=com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner&text=AfdOriginGroupInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.healthProbeSettings()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.healthProbeSettings()"
name: "healthProbeSettings()"
nameWithType: "AfdOriginGroupInner.healthProbeSettings()"
summary: "Get the health<wbr>Probe<wbr>Settings property: Health probe settings to the origin that is used to determine the health of the origin."
syntax: "public HealthProbeParameters healthProbeSettings()"
desc: "Get the healthProbeSettings property: Health probe settings to the origin that is used to determine the health of the origin."
returns:
description: "the healthProbeSettings value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.HealthProbeParameters?alt=com.azure.resourcemanager.cdn.models.HealthProbeParameters&text=HealthProbeParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.id()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.id()"
name: "id()"
nameWithType: "AfdOriginGroupInner.id()"
summary: "Get the id property: Fully qualified resource Id for the resource."
overridden: "com.azure.core.management.ProxyResource.id()"
syntax: "public String id()"
desc: "Get the id property: Fully qualified resource Id for the resource."
returns:
description: "the id value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.loadBalancingSettings()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.loadBalancingSettings()"
name: "loadBalancingSettings()"
nameWithType: "AfdOriginGroupInner.loadBalancingSettings()"
summary: "Get the load<wbr>Balancing<wbr>Settings property: Load balancing settings for a backend pool."
syntax: "public LoadBalancingSettingsParameters loadBalancingSettings()"
desc: "Get the loadBalancingSettings property: Load balancing settings for a backend pool."
returns:
description: "the loadBalancingSettings value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.LoadBalancingSettingsParameters?alt=com.azure.resourcemanager.cdn.models.LoadBalancingSettingsParameters&text=LoadBalancingSettingsParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.name()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.name()"
name: "name()"
nameWithType: "AfdOriginGroupInner.name()"
summary: "Get the name property: The name of the resource."
overridden: "com.azure.core.management.ProxyResource.name()"
syntax: "public String name()"
desc: "Get the name property: The name of the resource."
returns:
description: "the name value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.profileName()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.profileName()"
name: "profileName()"
nameWithType: "AfdOriginGroupInner.profileName()"
summary: "Get the profile<wbr>Name property: The name of the profile which holds the origin group."
syntax: "public String profileName()"
desc: "Get the profileName property: The name of the profile which holds the origin group."
returns:
description: "the profileName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.provisioningState()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.provisioningState()"
name: "provisioningState()"
nameWithType: "AfdOriginGroupInner.provisioningState()"
summary: "Get the provisioning<wbr>State property: Provisioning status."
syntax: "public AfdProvisioningState provisioningState()"
desc: "Get the provisioningState property: Provisioning status."
returns:
description: "the provisioningState value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.AfdProvisioningState?alt=com.azure.resourcemanager.cdn.models.AfdProvisioningState&text=AfdProvisioningState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.sessionAffinityState()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.sessionAffinityState()"
name: "sessionAffinityState()"
nameWithType: "AfdOriginGroupInner.sessionAffinityState()"
summary: "Get the session<wbr>Affinity<wbr>State property: Whether to allow session affinity on this host."
syntax: "public EnabledState sessionAffinityState()"
desc: "Get the sessionAffinityState property: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'."
returns:
description: "the sessionAffinityState value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EnabledState?alt=com.azure.resourcemanager.cdn.models.EnabledState&text=EnabledState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.systemData()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.systemData()"
name: "systemData()"
nameWithType: "AfdOriginGroupInner.systemData()"
summary: "Get the system<wbr>Data property: Read only system data."
syntax: "public SystemData systemData()"
desc: "Get the systemData property: Read only system data."
returns:
description: "the systemData value."
type: "<xref href=\"com.azure.core.management.SystemData?alt=com.azure.core.management.SystemData&text=SystemData\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "AfdOriginGroupInner.toJson(JsonWriter jsonWriter)"
overridden: "com.azure.core.management.ProxyResource.toJson(com.azure.json.JsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.trafficRestorationTimeToHealedOrNewEndpointsInMinutes()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.trafficRestorationTimeToHealedOrNewEndpointsInMinutes()"
name: "trafficRestorationTimeToHealedOrNewEndpointsInMinutes()"
nameWithType: "AfdOriginGroupInner.trafficRestorationTimeToHealedOrNewEndpointsInMinutes()"
summary: "Get the traffic<wbr>Restoration<wbr>Time<wbr>ToHealed<wbr>OrNew<wbr>Endpoints<wbr>InMinutes property: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added."
syntax: "public Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes()"
desc: "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:
description: "the trafficRestorationTimeToHealedOrNewEndpointsInMinutes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.type()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.type()"
name: "type()"
nameWithType: "AfdOriginGroupInner.type()"
summary: "Get the type property: The type of the resource."
overridden: "com.azure.core.management.ProxyResource.type()"
syntax: "public String type()"
desc: "Get the type property: The type of the resource."
returns:
description: "the type value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.validate()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.validate()"
name: "validate()"
nameWithType: "AfdOriginGroupInner.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.withHealthProbeSettings(com.azure.resourcemanager.cdn.models.HealthProbeParameters)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.withHealthProbeSettings(HealthProbeParameters healthProbeSettings)"
name: "withHealthProbeSettings(HealthProbeParameters healthProbeSettings)"
nameWithType: "AfdOriginGroupInner.withHealthProbeSettings(HealthProbeParameters healthProbeSettings)"
summary: "Set the health<wbr>Probe<wbr>Settings property: Health probe settings to the origin that is used to determine the health of the origin."
parameters:
- description: "the healthProbeSettings value to set."
name: "healthProbeSettings"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.HealthProbeParameters?alt=com.azure.resourcemanager.cdn.models.HealthProbeParameters&text=HealthProbeParameters\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AfdOriginGroupInner withHealthProbeSettings(HealthProbeParameters healthProbeSettings)"
desc: "Set the healthProbeSettings property: Health probe settings to the origin that is used to determine the health of the origin."
returns:
description: "the AfdOriginGroupInner object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner?alt=com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner&text=AfdOriginGroupInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.withLoadBalancingSettings(com.azure.resourcemanager.cdn.models.LoadBalancingSettingsParameters)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.withLoadBalancingSettings(LoadBalancingSettingsParameters loadBalancingSettings)"
name: "withLoadBalancingSettings(LoadBalancingSettingsParameters loadBalancingSettings)"
nameWithType: "AfdOriginGroupInner.withLoadBalancingSettings(LoadBalancingSettingsParameters loadBalancingSettings)"
summary: "Set the load<wbr>Balancing<wbr>Settings property: Load balancing settings for a backend pool."
parameters:
- description: "the loadBalancingSettings value to set."
name: "loadBalancingSettings"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.LoadBalancingSettingsParameters?alt=com.azure.resourcemanager.cdn.models.LoadBalancingSettingsParameters&text=LoadBalancingSettingsParameters\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AfdOriginGroupInner withLoadBalancingSettings(LoadBalancingSettingsParameters loadBalancingSettings)"
desc: "Set the loadBalancingSettings property: Load balancing settings for a backend pool."
returns:
description: "the AfdOriginGroupInner object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner?alt=com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner&text=AfdOriginGroupInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.withSessionAffinityState(com.azure.resourcemanager.cdn.models.EnabledState)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.withSessionAffinityState(EnabledState sessionAffinityState)"
name: "withSessionAffinityState(EnabledState sessionAffinityState)"
nameWithType: "AfdOriginGroupInner.withSessionAffinityState(EnabledState sessionAffinityState)"
summary: "Set the session<wbr>Affinity<wbr>State property: Whether to allow session affinity on this host."
parameters:
- description: "the sessionAffinityState value to set."
name: "sessionAffinityState"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EnabledState?alt=com.azure.resourcemanager.cdn.models.EnabledState&text=EnabledState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AfdOriginGroupInner withSessionAffinityState(EnabledState sessionAffinityState)"
desc: "Set the sessionAffinityState property: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'."
returns:
description: "the AfdOriginGroupInner object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner?alt=com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner&text=AfdOriginGroupInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(java.lang.Integer)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner.withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes)"
name: "withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes)"
nameWithType: "AfdOriginGroupInner.withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes)"
summary: "Set the traffic<wbr>Restoration<wbr>Time<wbr>ToHealed<wbr>OrNew<wbr>Endpoints<wbr>InMinutes property: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added."
parameters:
- description: "the\n trafficRestorationTimeToHealedOrNewEndpointsInMinutes value to set."
name: "trafficRestorationTimeToHealedOrNewEndpointsInMinutes"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public AfdOriginGroupInner withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes)"
desc: "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."
returns:
description: "the AfdOriginGroupInner object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner?alt=com.azure.resourcemanager.cdn.fluent.models.AfdOriginGroupInner&text=AfdOriginGroupInner\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door."
metadata: {}
package: "com.azure.resourcemanager.cdn.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cdn:2.44.0