Share via

EndpointInner Class

  • Reference
Package:
com.azure.resourcemanager.trafficmanager.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-trafficmanager:2.44.0

public final class EndpointInner
extends ProxyResource

Class representing a Traffic Manager endpoint.

Constructor Summary

Constructor Description
EndpointInner()

Creates an instance of EndpointInner class.

Method Summary

Modifier and Type Method and Description
AlwaysServe alwaysServe()

Get the alwaysServe property: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
List<EndpointPropertiesCustomHeadersItem> customHeaders()

Get the customHeaders property: List of custom headers.
String endpointLocation()

Get the endpointLocation property: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
EndpointMonitorStatus endpointMonitorStatus()

Get the endpointMonitorStatus property: The monitoring status of the endpoint.
EndpointStatus endpointStatus()

Get the endpointStatus property: The status of the endpoint.
static EndpointInner fromJson(JsonReader jsonReader)

Reads an instance of EndpointInner from the JsonReader.
List<String> geoMapping()

Get the geoMapping property: The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method.
String id()

Get the id property: Fully qualified resource Id for the resource.
Long minChildEndpoints()

Get the minChildEndpoints property: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available.
Long minChildEndpointsIPv4()

Get the minChildEndpointsIPv4 property: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available.
Long minChildEndpointsIPv6()

Get the minChildEndpointsIPv6 property: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available.
String name()

Get the name property: The name of the resource.
Long priority()

Get the priority property: The priority of this endpoint when using the 'Priority' traffic routing method.
List<EndpointPropertiesSubnetsItem> subnets()

Get the subnets property: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method.
String target()

Get the target property: The fully-qualified DNS name or IP address of the endpoint.
String targetResourceId()

Get the targetResourceId property: The Azure Resource URI of the of the endpoint.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
void validate()

Validates the instance.
Long weight()

Get the weight property: The weight of this endpoint when using the 'Weighted' traffic routing method.
EndpointInner withAlwaysServe(AlwaysServe alwaysServe)

Set the alwaysServe property: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
EndpointInner withCustomHeaders(List<EndpointPropertiesCustomHeadersItem> customHeaders)

Set the customHeaders property: List of custom headers.
EndpointInner withEndpointLocation(String endpointLocation)

Set the endpointLocation property: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
EndpointInner withEndpointMonitorStatus(EndpointMonitorStatus endpointMonitorStatus)

Set the endpointMonitorStatus property: The monitoring status of the endpoint.
EndpointInner withEndpointStatus(EndpointStatus endpointStatus)

Set the endpointStatus property: The status of the endpoint.
EndpointInner withGeoMapping(List<String> geoMapping)

Set the geoMapping property: The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method.
EndpointInner withId(String id)

Set the id property: Fully qualified resource Id for the resource.
EndpointInner withMinChildEndpoints(Long minChildEndpoints)

Set the minChildEndpoints property: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available.
EndpointInner withMinChildEndpointsIPv4(Long minChildEndpointsIPv4)

Set the minChildEndpointsIPv4 property: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available.
EndpointInner withMinChildEndpointsIPv6(Long minChildEndpointsIPv6)

Set the minChildEndpointsIPv6 property: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available.
EndpointInner withName(String name)

Set the name property: The name of the resource.
EndpointInner withPriority(Long priority)

Set the priority property: The priority of this endpoint when using the 'Priority' traffic routing method.
EndpointInner withSubnets(List<EndpointPropertiesSubnetsItem> subnets)

Set the subnets property: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method.
EndpointInner withTarget(String target)

Set the target property: The fully-qualified DNS name or IP address of the endpoint.
EndpointInner withTargetResourceId(String targetResourceId)

Set the targetResourceId property: The Azure Resource URI of the of the endpoint.
EndpointInner withType(String type)

Set the type property: The type of the resource.
EndpointInner withWeight(Long weight)

Set the weight property: The weight of this endpoint when using the 'Weighted' traffic routing method.

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

EndpointInner

public EndpointInner()

Creates an instance of EndpointInner class.

Method Details

alwaysServe

public AlwaysServe alwaysServe()

Get the alwaysServe property: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.

Returns:

the alwaysServe value.

customHeaders

public List customHeaders()

Get the customHeaders property: List of custom headers.

Returns:

the customHeaders value.

endpointLocation

public String endpointLocation()

Get the endpointLocation property: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.

Returns:

the endpointLocation value.

endpointMonitorStatus

public EndpointMonitorStatus endpointMonitorStatus()

Get the endpointMonitorStatus property: The monitoring status of the endpoint.

Returns:

the endpointMonitorStatus value.

endpointStatus

public EndpointStatus endpointStatus()

Get the endpointStatus property: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.

Returns:

the endpointStatus value.

fromJson

public static EndpointInner fromJson(JsonReader jsonReader)

Reads an instance of EndpointInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

geoMapping

public List geoMapping()

Get the geoMapping property: The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.

Returns:

the geoMapping value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}.

Overrides:

EndpointInner.id()

Returns:

the id value.

minChildEndpoints

public Long minChildEndpoints()

Get the minChildEndpoints property: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

Returns:

the minChildEndpoints value.

minChildEndpointsIPv4

public Long minChildEndpointsIPv4()

Get the minChildEndpointsIPv4 property: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

Returns:

the minChildEndpointsIPv4 value.

minChildEndpointsIPv6

public Long minChildEndpointsIPv6()

Get the minChildEndpointsIPv6 property: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

Returns:

the minChildEndpointsIPv6 value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

EndpointInner.name()

Returns:

the name value.

priority

public Long priority()

Get the priority property: The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.

Returns:

the priority value.

subnets

public List subnets()

Get the subnets property: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.

Returns:

the subnets value.

target

public String target()

Get the target property: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.

Returns:

the target value.

targetResourceId

public String targetResourceId()

Get the targetResourceId property: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.

Returns:

the targetResourceId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

EndpointInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

Overrides:

EndpointInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

weight

public Long weight()

Get the weight property: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

Returns:

the weight value.

withAlwaysServe

public EndpointInner withAlwaysServe(AlwaysServe alwaysServe)

Set the alwaysServe property: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.

Parameters:

alwaysServe - the alwaysServe value to set.

Returns:

the EndpointInner object itself.

withCustomHeaders

public EndpointInner withCustomHeaders(List customHeaders)

Set the customHeaders property: List of custom headers.

Parameters:

customHeaders - the customHeaders value to set.

Returns:

the EndpointInner object itself.

withEndpointLocation

public EndpointInner withEndpointLocation(String endpointLocation)

Set the endpointLocation property: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.

Parameters:

endpointLocation - the endpointLocation value to set.

Returns:

the EndpointInner object itself.

withEndpointMonitorStatus

public EndpointInner withEndpointMonitorStatus(EndpointMonitorStatus endpointMonitorStatus)

Set the endpointMonitorStatus property: The monitoring status of the endpoint.

Parameters:

endpointMonitorStatus - the endpointMonitorStatus value to set.

Returns:

the EndpointInner object itself.

withEndpointStatus

public EndpointInner withEndpointStatus(EndpointStatus endpointStatus)

Set the endpointStatus property: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.

Parameters:

endpointStatus - the endpointStatus value to set.

Returns:

the EndpointInner object itself.

withGeoMapping

public EndpointInner withGeoMapping(List geoMapping)

Set the geoMapping property: The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.

Parameters:

geoMapping - the geoMapping value to set.

Returns:

the EndpointInner object itself.

withId

public EndpointInner withId(String id)

Set the id property: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}.

Parameters:

id - the id value to set.

Returns:

the EndpointInner object itself.

withMinChildEndpoints

public EndpointInner withMinChildEndpoints(Long minChildEndpoints)

Set the minChildEndpoints property: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

Parameters:

minChildEndpoints - the minChildEndpoints value to set.

Returns:

the EndpointInner object itself.

withMinChildEndpointsIPv4

public EndpointInner withMinChildEndpointsIPv4(Long minChildEndpointsIPv4)

Set the minChildEndpointsIPv4 property: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

Parameters:

minChildEndpointsIPv4 - the minChildEndpointsIPv4 value to set.

Returns:

the EndpointInner object itself.

withMinChildEndpointsIPv6

public EndpointInner withMinChildEndpointsIPv6(Long minChildEndpointsIPv6)

Set the minChildEndpointsIPv6 property: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

Parameters:

minChildEndpointsIPv6 - the minChildEndpointsIPv6 value to set.

Returns:

the EndpointInner object itself.

withName

public EndpointInner withName(String name)

Set the name property: The name of the resource.

Parameters:

name - the name value to set.

Returns:

the EndpointInner object itself.

withPriority

public EndpointInner withPriority(Long priority)

Set the priority property: The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.

Parameters:

priority - the priority value to set.

Returns:

the EndpointInner object itself.

withSubnets

public EndpointInner withSubnets(List subnets)

Set the subnets property: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.

Parameters:

subnets - the subnets value to set.

Returns:

the EndpointInner object itself.

withTarget

public EndpointInner withTarget(String target)

Set the target property: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.

Parameters:

target - the target value to set.

Returns:

the EndpointInner object itself.

withTargetResourceId

public EndpointInner withTargetResourceId(String targetResourceId)

Set the targetResourceId property: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.

Parameters:

targetResourceId - the targetResourceId value to set.

Returns:

the EndpointInner object itself.

withType

public EndpointInner withType(String type)

Set the type property: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

Parameters:

type - the type value to set.

Returns:

the EndpointInner object itself.

withWeight

public EndpointInner withWeight(Long weight)

Set the weight property: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

Parameters:

weight - the weight value to set.

Returns:

the EndpointInner object itself.

Applies to