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

164 строки
18 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties"
name: "OriginGroupProperties"
nameWithType: "OriginGroupProperties"
summary: "The JSON object that contains the properties of the origin group."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters&text=OriginGroupUpdatePropertiesParameters\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.fromJson(com.azure.json.JsonReader)?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.healthProbeSettings()?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.healthProbeSettings&text=healthProbeSettings\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.origins()?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.origins&text=origins\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.responseBasedOriginErrorDetectionSettings()?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.responseBasedOriginErrorDetectionSettings&text=responseBasedOriginErrorDetectionSettings\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.toJson(com.azure.json.JsonWriter)?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.trafficRestorationTimeToHealedOrNewEndpointsInMinutes()?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.trafficRestorationTimeToHealedOrNewEndpointsInMinutes&text=trafficRestorationTimeToHealedOrNewEndpointsInMinutes\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.validate()?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.validate&text=validate\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withHealthProbeSettings(com.azure.resourcemanager.cdn.models.HealthProbeParameters)?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withHealthProbeSettings&text=withHealthProbeSettings\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withOrigins(java.util.List<com.azure.resourcemanager.cdn.models.ResourceReference>)?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withOrigins&text=withOrigins\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withResponseBasedOriginErrorDetectionSettings(com.azure.resourcemanager.cdn.models.ResponseBasedOriginErrorDetectionParameters)?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withResponseBasedOriginErrorDetectionSettings&text=withResponseBasedOriginErrorDetectionSettings\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(java.lang.Integer)?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes&text=withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes\" 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 **OriginGroupProperties**</br> extends <xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters&text=OriginGroupUpdatePropertiesParameters\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.OriginGroupProperties()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.OriginGroupProperties()"
name: "OriginGroupProperties()"
nameWithType: "OriginGroupProperties.OriginGroupProperties()"
summary: "Creates an instance of Origin<wbr>Group<wbr>Properties class."
syntax: "public OriginGroupProperties()"
desc: "Creates an instance of OriginGroupProperties class."
methods:
- uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "OriginGroupProperties.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Origin<wbr>Group<wbr>Properties 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 OriginGroupProperties fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the OriginGroupProperties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of OriginGroupProperties from the JsonReader."
returns:
description: "An instance of OriginGroupProperties if the JsonReader was pointing to an instance of it, or null if it\n was pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties&text=OriginGroupProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.provisioningState()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.provisioningState()"
name: "provisioningState()"
nameWithType: "OriginGroupProperties.provisioningState()"
summary: "Get the provisioning<wbr>State property: Provisioning status of the origin group."
syntax: "public OriginGroupProvisioningState provisioningState()"
desc: "Get the provisioningState property: Provisioning status of the origin group."
returns:
description: "the provisioningState value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.OriginGroupProvisioningState?alt=com.azure.resourcemanager.cdn.models.OriginGroupProvisioningState&text=OriginGroupProvisioningState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.resourceState()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.resourceState()"
name: "resourceState()"
nameWithType: "OriginGroupProperties.resourceState()"
summary: "Get the resource<wbr>State property: Resource status of the origin group."
syntax: "public OriginGroupResourceState resourceState()"
desc: "Get the resourceState property: Resource status of the origin group."
returns:
description: "the resourceState value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.OriginGroupResourceState?alt=com.azure.resourcemanager.cdn.models.OriginGroupResourceState&text=OriginGroupResourceState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "OriginGroupProperties.toJson(JsonWriter jsonWriter)"
overridden: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.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.OriginGroupProperties.validate()"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.validate()"
name: "validate()"
nameWithType: "OriginGroupProperties.validate()"
summary: "Validates the instance."
overridden: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.validate()"
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.withHealthProbeSettings(com.azure.resourcemanager.cdn.models.HealthProbeParameters)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.withHealthProbeSettings(HealthProbeParameters healthProbeSettings)"
name: "withHealthProbeSettings(HealthProbeParameters healthProbeSettings)"
nameWithType: "OriginGroupProperties.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."
overridden: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withHealthProbeSettings(com.azure.resourcemanager.cdn.models.HealthProbeParameters)"
parameters:
- 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 OriginGroupProperties 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:
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties&text=OriginGroupProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.withOrigins(java.util.List<com.azure.resourcemanager.cdn.models.ResourceReference>)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.withOrigins(List<ResourceReference> origins)"
name: "withOrigins(List<ResourceReference> origins)"
nameWithType: "OriginGroupProperties.withOrigins(List<ResourceReference> origins)"
summary: "Set the origins property: The source of the content being delivered via CDN within given origin group."
overridden: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withOrigins(java.util.List<com.azure.resourcemanager.cdn.models.ResourceReference>)"
parameters:
- name: "origins"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.cdn.models.ResourceReference?alt=com.azure.resourcemanager.cdn.models.ResourceReference&text=ResourceReference\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public OriginGroupProperties withOrigins(List<ResourceReference> origins)"
desc: "Set the origins property: The source of the content being delivered via CDN within given origin group."
returns:
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties&text=OriginGroupProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.withResponseBasedOriginErrorDetectionSettings(com.azure.resourcemanager.cdn.models.ResponseBasedOriginErrorDetectionParameters)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.withResponseBasedOriginErrorDetectionSettings(ResponseBasedOriginErrorDetectionParameters responseBasedOriginErrorDetectionSettings)"
name: "withResponseBasedOriginErrorDetectionSettings(ResponseBasedOriginErrorDetectionParameters responseBasedOriginErrorDetectionSettings)"
nameWithType: "OriginGroupProperties.withResponseBasedOriginErrorDetectionSettings(ResponseBasedOriginErrorDetectionParameters responseBasedOriginErrorDetectionSettings)"
summary: "Set the response<wbr>Based<wbr>Origin<wbr>Error<wbr>Detection<wbr>Settings property: The JSON object that contains the properties to determine origin health using real requests/responses."
overridden: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withResponseBasedOriginErrorDetectionSettings(com.azure.resourcemanager.cdn.models.ResponseBasedOriginErrorDetectionParameters)"
parameters:
- name: "responseBasedOriginErrorDetectionSettings"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.ResponseBasedOriginErrorDetectionParameters?alt=com.azure.resourcemanager.cdn.models.ResponseBasedOriginErrorDetectionParameters&text=ResponseBasedOriginErrorDetectionParameters\" data-throw-if-not-resolved=\"False\" />"
syntax: "public OriginGroupProperties withResponseBasedOriginErrorDetectionSettings(ResponseBasedOriginErrorDetectionParameters responseBasedOriginErrorDetectionSettings)"
desc: "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."
returns:
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties&text=OriginGroupProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(java.lang.Integer)"
fullName: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties.withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes)"
name: "withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(Integer trafficRestorationTimeToHealedOrNewEndpointsInMinutes)"
nameWithType: "OriginGroupProperties.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."
overridden: "com.azure.resourcemanager.cdn.fluent.models.OriginGroupUpdatePropertiesParameters.withTrafficRestorationTimeToHealedOrNewEndpointsInMinutes(java.lang.Integer)"
parameters:
- name: "trafficRestorationTimeToHealedOrNewEndpointsInMinutes"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public OriginGroupProperties 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:
type: "<xref href=\"com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties?alt=com.azure.resourcemanager.cdn.fluent.models.OriginGroupProperties&text=OriginGroupProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The JSON object that contains the properties of the origin group."
metadata: {}
package: "com.azure.resourcemanager.cdn.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cdn:2.44.0