ALBDnsServiceApplicationProfile (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.ALBDnsServiceApplicationProfile

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ALBDnsServiceApplicationProfile
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Advanced load balancer DnsServiceApplicationProfile object

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBDnsServiceApplicationProfile.Builder
Builder class for ALBDnsServiceApplicationProfile.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ALBDnsServiceApplicationProfile.Builder` Builder class for `ALBDnsServiceApplicationProfile`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ERROR_RESPONSE_ERROR`
`static java.lang.String`	`ERROR_RESPONSE_NONE`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ALBDnsServiceApplicationProfile()` Default constructor.
`protected`	`ALBDnsServiceApplicationProfile(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static ALBDnsServiceApplicationProfile`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static ALBDnsServiceApplicationProfile`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Boolean`	`getAaaaEmptyResponse()` Respond to AAAA queries with empty response when there are only IPV4 records.
`java.lang.String`	`getAdminEmail()` Email address of the administrator responsible for this zone.
`java.lang.Boolean`	`getDnsOverTcpEnabled()` Enable DNS query/response over TCP.
`java.util.List<ALBDnsZone>`	`getDnsZones()` DNS zones hosted on this Virtual Service.
`java.util.List<java.lang.String>`	`getDomainNames()` Subdomain names serviced by this Virtual Service.
`java.lang.Boolean`	`getEcsStrippingEnabled()` Enable stripping of EDNS client subnet (ecs) option towards client if DNS service inserts ecs option in the DNS query towards upstream servers.
`java.lang.Boolean`	`getEdns()` Enable DNS service to be aware of EDNS (Extension mechanism for DNS).
`java.lang.Long`	`getEdnsClientSubnetPrefixLen()` Specifies the IP address prefix length to use in the EDNS client subnet (ECS) option.
`java.lang.String`	`getErrorResponse()` Possible values are: `ERROR_RESPONSE_ERROR` `ERROR_RESPONSE_NONE` Drop or respond to client when the DNS service encounters an error processing a client query.
`java.lang.String`	`getNameServer()`
`java.lang.Long`	`getNegativeCachingTtl()` Specifies the TTL value (in seconds) for SOA (Start of Authority) (corresponding to a authoritative domain owned by this DNS Virtual Service) record's minimum TTL served by the DNS Virtual Service.
`java.lang.Long`	`getNumDnsIp()` Specifies the number of IP addresses returned by the DNS Service.
`java.lang.Long`	`getTtl()` Specifies the TTL value (in seconds) for records served by DNS Service.
`int`	`hashCode()`
`void`	`setAaaaEmptyResponse(java.lang.Boolean aaaaEmptyResponse)` Respond to AAAA queries with empty response when there are only IPV4 records.
`void`	`setAdminEmail(java.lang.String adminEmail)` Email address of the administrator responsible for this zone.
`void`	`setDnsOverTcpEnabled(java.lang.Boolean dnsOverTcpEnabled)` Enable DNS query/response over TCP.
`void`	`setDnsZones(java.util.List<ALBDnsZone> dnsZones)` DNS zones hosted on this Virtual Service.
`void`	`setDomainNames(java.util.List<java.lang.String> domainNames)` Subdomain names serviced by this Virtual Service.
`void`	`setEcsStrippingEnabled(java.lang.Boolean ecsStrippingEnabled)` Enable stripping of EDNS client subnet (ecs) option towards client if DNS service inserts ecs option in the DNS query towards upstream servers.
`void`	`setEdns(java.lang.Boolean edns)` Enable DNS service to be aware of EDNS (Extension mechanism for DNS).
`void`	`setEdnsClientSubnetPrefixLen(java.lang.Long ednsClientSubnetPrefixLen)` Specifies the IP address prefix length to use in the EDNS client subnet (ECS) option.
`void`	`setErrorResponse(java.lang.String errorResponse)` Possible values are: `ERROR_RESPONSE_ERROR` `ERROR_RESPONSE_NONE` Drop or respond to client when the DNS service encounters an error processing a client query.
`void`	`setNameServer(java.lang.String nameServer)`
`void`	`setNegativeCachingTtl(java.lang.Long negativeCachingTtl)` Specifies the TTL value (in seconds) for SOA (Start of Authority) (corresponding to a authoritative domain owned by this DNS Virtual Service) record's minimum TTL served by the DNS Virtual Service.
`void`	`setNumDnsIp(java.lang.Long numDnsIp)` Specifies the number of IP addresses returned by the DNS Service.
`void`	`setTtl(java.lang.Long ttl)` Specifies the TTL value (in seconds) for records served by DNS Service.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ERROR_RESPONSE_ERROR
```
public static final java.lang.String ERROR_RESPONSE_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_RESPONSE_NONE
```
public static final java.lang.String ERROR_RESPONSE_NONE
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBDnsServiceApplicationProfile
```
public ALBDnsServiceApplicationProfile()
```
    Default constructor.
  - ALBDnsServiceApplicationProfile
```
protected ALBDnsServiceApplicationProfile(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAaaaEmptyResponse
```
public java.lang.Boolean getAaaaEmptyResponse()
```
    Respond to AAAA queries with empty response when there are only IPV4 records. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setAaaaEmptyResponse
```
public void setAaaaEmptyResponse(java.lang.Boolean aaaaEmptyResponse)
```
    Respond to AAAA queries with empty response when there are only IPV4 records. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    aaaaEmptyResponse - New value for the property.
  - getAdminEmail
```
public java.lang.String getAdminEmail()
```
    Email address of the administrator responsible for this zone. This field is used in SOA records (rname) pertaining to all domain names specified as authoritative domain names. If not configured, the default value 'hostmaster' is used in SOA responses. Default value when not specified in API or module is interpreted by ALB Controller as hostmaster.
    
    Returns:
    
    The current value of the property.
  - setAdminEmail
```
public void setAdminEmail(java.lang.String adminEmail)
```
    Email address of the administrator responsible for this zone. This field is used in SOA records (rname) pertaining to all domain names specified as authoritative domain names. If not configured, the default value 'hostmaster' is used in SOA responses. Default value when not specified in API or module is interpreted by ALB Controller as hostmaster.
    
    Parameters:
    
    adminEmail - New value for the property.
  - getDnsOverTcpEnabled
```
public java.lang.Boolean getDnsOverTcpEnabled()
```
    Enable DNS query/response over TCP. This enables analytics for pass-through queries as well. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setDnsOverTcpEnabled
```
public void setDnsOverTcpEnabled(java.lang.Boolean dnsOverTcpEnabled)
```
    Enable DNS query/response over TCP. This enables analytics for pass-through queries as well. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    dnsOverTcpEnabled - New value for the property.
  - getDnsZones
```
public java.util.List<ALBDnsZone> getDnsZones()
```
    DNS zones hosted on this Virtual Service. Maximum of 100 items allowed.
    
    Returns:
    
    The current value of the property.
  - setDnsZones
```
public void setDnsZones(java.util.List<ALBDnsZone> dnsZones)
```
    DNS zones hosted on this Virtual Service. Maximum of 100 items allowed.
    
    Parameters:
    
    dnsZones - New value for the property.
  - getDomainNames
```
public java.util.List<java.lang.String> getDomainNames()
```
    Subdomain names serviced by this Virtual Service. These are configured as Ends-With semantics. Maximum of 100 items allowed.
    
    Returns:
    
    The current value of the property.
  - setDomainNames
```
public void setDomainNames(java.util.List<java.lang.String> domainNames)
```
    Subdomain names serviced by this Virtual Service. These are configured as Ends-With semantics. Maximum of 100 items allowed.
    
    Parameters:
    
    domainNames - New value for the property.
  - getEcsStrippingEnabled
```
public java.lang.Boolean getEcsStrippingEnabled()
```
    Enable stripping of EDNS client subnet (ecs) option towards client if DNS service inserts ecs option in the DNS query towards upstream servers. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setEcsStrippingEnabled
```
public void setEcsStrippingEnabled(java.lang.Boolean ecsStrippingEnabled)
```
    Enable stripping of EDNS client subnet (ecs) option towards client if DNS service inserts ecs option in the DNS query towards upstream servers. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    ecsStrippingEnabled - New value for the property.
  - getEdns
```
public java.lang.Boolean getEdns()
```
    Enable DNS service to be aware of EDNS (Extension mechanism for DNS). EDNS extensions are parsed and shown in logs. For GSLB services, the EDNS client subnet option can be used to influence Load Balancing. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setEdns
```
public void setEdns(java.lang.Boolean edns)
```
    Enable DNS service to be aware of EDNS (Extension mechanism for DNS). EDNS extensions are parsed and shown in logs. For GSLB services, the EDNS client subnet option can be used to influence Load Balancing. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    edns - New value for the property.
  - getEdnsClientSubnetPrefixLen
```
public java.lang.Long getEdnsClientSubnetPrefixLen()
```
    Specifies the IP address prefix length to use in the EDNS client subnet (ECS) option. When the incoming request does not have any ECS option and the prefix length is specified, an ECS option is inserted in the request passed to upstream server. If the incoming request already has an ECS option, the prefix length (and correspondingly the address) in the ECS option is updated, with the minimum of the prefix length present in the incoming and the configured prefix length, before passing the request to upstream server. Allowed values are 1-32. format: int64
    
    Returns:
    
    The current value of the property.
  - setEdnsClientSubnetPrefixLen
```
public void setEdnsClientSubnetPrefixLen(java.lang.Long ednsClientSubnetPrefixLen)
```
    Specifies the IP address prefix length to use in the EDNS client subnet (ECS) option. When the incoming request does not have any ECS option and the prefix length is specified, an ECS option is inserted in the request passed to upstream server. If the incoming request already has an ECS option, the prefix length (and correspondingly the address) in the ECS option is updated, with the minimum of the prefix length present in the incoming and the configured prefix length, before passing the request to upstream server. Allowed values are 1-32. format: int64
    
    Parameters:
    
    ednsClientSubnetPrefixLen - New value for the property.
  - getErrorResponse
```
public java.lang.String getErrorResponse()
```
    Possible values are:
    - ERROR_RESPONSE_ERROR
    - ERROR_RESPONSE_NONE
    Drop or respond to client when the DNS service encounters an error processing a client query. By default, such a request is dropped without any response, or passed through to a passthrough pool, if configured. When set to respond, an appropriate response is sent to client, e.g. NXDOMAIN response for non-existent records, empty NOERROR response for unsupported queries, etc. Enum options - DNS_ERROR_RESPONSE_ERROR, DNS_ERROR_RESPONSE_NONE. Default value when not specified in API or module is interpreted by ALB Controller as DNS_ERROR_RESPONSE_NONE.
    Returns:
    
    The current value of the property.
  - setErrorResponse
```
public void setErrorResponse(java.lang.String errorResponse)
```
    Possible values are:
    - ERROR_RESPONSE_ERROR
    - ERROR_RESPONSE_NONE
    Drop or respond to client when the DNS service encounters an error processing a client query. By default, such a request is dropped without any response, or passed through to a passthrough pool, if configured. When set to respond, an appropriate response is sent to client, e.g. NXDOMAIN response for non-existent records, empty NOERROR response for unsupported queries, etc. Enum options - DNS_ERROR_RESPONSE_ERROR, DNS_ERROR_RESPONSE_NONE. Default value when not specified in API or module is interpreted by ALB Controller as DNS_ERROR_RESPONSE_NONE.
    Parameters:
    
    errorResponse - New value for the property.
  - getNameServer
```
public java.lang.String getNameServer()
```
    Returns:
    
    The current value of the property.
  - setNameServer
```
public void setNameServer(java.lang.String nameServer)
```
    Parameters:
    
    nameServer - New value for the property.
  - getNegativeCachingTtl
```
public java.lang.Long getNegativeCachingTtl()
```
    Specifies the TTL value (in seconds) for SOA (Start of Authority) (corresponding to a authoritative domain owned by this DNS Virtual Service) record's minimum TTL served by the DNS Virtual Service. Allowed values are 0-86400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 30. format: int64
    
    Returns:
    
    The current value of the property.
  - setNegativeCachingTtl
```
public void setNegativeCachingTtl(java.lang.Long negativeCachingTtl)
```
    Specifies the TTL value (in seconds) for SOA (Start of Authority) (corresponding to a authoritative domain owned by this DNS Virtual Service) record's minimum TTL served by the DNS Virtual Service. Allowed values are 0-86400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 30. format: int64
    
    Parameters:
    
    negativeCachingTtl - New value for the property.
  - getNumDnsIp
```
public java.lang.Long getNumDnsIp()
```
    Specifies the number of IP addresses returned by the DNS Service. Enter 0 to return all IP addresses. Allowed values are 1-20. Special values are 0- 'Return all IP addresses'. Default value when not specified in API or module is interpreted by ALB Controller as 1. format: int64
    
    Returns:
    
    The current value of the property.
  - setNumDnsIp
```
public void setNumDnsIp(java.lang.Long numDnsIp)
```
    Specifies the number of IP addresses returned by the DNS Service. Enter 0 to return all IP addresses. Allowed values are 1-20. Special values are 0- 'Return all IP addresses'. Default value when not specified in API or module is interpreted by ALB Controller as 1. format: int64
    
    Parameters:
    
    numDnsIp - New value for the property.
  - getTtl
```
public java.lang.Long getTtl()
```
    Specifies the TTL value (in seconds) for records served by DNS Service. Allowed values are 0-86400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 30. format: int64
    
    Returns:
    
    The current value of the property.
  - setTtl
```
public void setTtl(java.lang.Long ttl)
```
    Specifies the TTL value (in seconds) for records served by DNS Service. Allowed values are 0-86400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 30. format: int64
    
    Parameters:
    
    ttl - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static ALBDnsServiceApplicationProfile _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static ALBDnsServiceApplicationProfile _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBDnsServiceApplicationProfile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR_RESPONSE_ERROR

ERROR_RESPONSE_NONE

__dynamicStructureFields

Constructor Detail

ALBDnsServiceApplicationProfile

ALBDnsServiceApplicationProfile

Method Detail

getAaaaEmptyResponse

setAaaaEmptyResponse

getAdminEmail

setAdminEmail

getDnsOverTcpEnabled

setDnsOverTcpEnabled

getDnsZones

setDnsZones

getDomainNames

setDomainNames

getEcsStrippingEnabled

setEcsStrippingEnabled

getEdns

setEdns

getEdnsClientSubnetPrefixLen

setEdnsClientSubnetPrefixLen

getErrorResponse

setErrorResponse

getNameServer

setNameServer

getNegativeCachingTtl

setNegativeCachingTtl

getNumDnsIp

setNumDnsIp

getTtl

setTtl

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2