Policy (Cloud DNS API v1-rev20220630-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.dns.model.Policy

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Policy
extends GenericJson
```
A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud DNS API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Policy()

Constructors
Constructor and Description
`Policy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Policy`	`clone()`
`PolicyAlternativeNameServerConfig`	`getAlternativeNameServerConfig()` Sets an alternative name server for the associated networks.
`String`	`getDescription()` A mutable string of at most 1024 characters associated with this resource for the user's convenience.
`Boolean`	`getEnableInboundForwarding()` Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections.
`Boolean`	`getEnableLogging()` Controls whether logging is enabled for the networks bound to this policy.
`BigInteger`	`getId()` Unique identifier for the resource; defined by the server (output only).
`String`	`getKind()`
`String`	`getName()` User-assigned name for this policy.
`List<PolicyNetwork>`	`getNetworks()` List of network names specifying networks to which this policy is applied.
`Policy`	`set(String fieldName, Object value)`
`Policy`	`setAlternativeNameServerConfig(PolicyAlternativeNameServerConfig alternativeNameServerConfig)` Sets an alternative name server for the associated networks.
`Policy`	`setDescription(String description)` A mutable string of at most 1024 characters associated with this resource for the user's convenience.
`Policy`	`setEnableInboundForwarding(Boolean enableInboundForwarding)` Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections.
`Policy`	`setEnableLogging(Boolean enableLogging)` Controls whether logging is enabled for the networks bound to this policy.
`Policy`	`setId(BigInteger id)` Unique identifier for the resource; defined by the server (output only).
`Policy`	`setKind(String kind)`
`Policy`	`setName(String name)` User-assigned name for this policy.
`Policy`	`setNetworks(List<PolicyNetwork> networks)` List of network names specifying networks to which this policy is applied.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Policy
```
public Policy()
```
- Method Detail
  - getAlternativeNameServerConfig
```
public PolicyAlternativeNameServerConfig getAlternativeNameServerConfig()
```
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    
    Returns:
    
    value or null for none
  - setAlternativeNameServerConfig
```
public Policy setAlternativeNameServerConfig(PolicyAlternativeNameServerConfig alternativeNameServerConfig)
```
    Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    
    Parameters:
    
    alternativeNameServerConfig - alternativeNameServerConfig or null for none
  - getDescription
```
public String getDescription()
```
    A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Policy setDescription(String description)
```
    A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
    
    Parameters:
    
    description - description or null for none
  - getEnableInboundForwarding
```
public Boolean getEnableInboundForwarding()
```
    Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
    
    Returns:
    
    value or null for none
  - setEnableInboundForwarding
```
public Policy setEnableInboundForwarding(Boolean enableInboundForwarding)
```
    Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
    
    Parameters:
    
    enableInboundForwarding - enableInboundForwarding or null for none
  - getEnableLogging
```
public Boolean getEnableLogging()
```
    Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
    
    Returns:
    
    value or null for none
  - setEnableLogging
```
public Policy setEnableLogging(Boolean enableLogging)
```
    Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
    
    Parameters:
    
    enableLogging - enableLogging or null for none
  - getId
```
public BigInteger getId()
```
    Unique identifier for the resource; defined by the server (output only).
    
    Returns:
    
    value or null for none
  - setId
```
public Policy setId(BigInteger id)
```
    Unique identifier for the resource; defined by the server (output only).
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public String getKind()
```
    Returns:
    
    value or null for none
  - setKind
```
public Policy setKind(String kind)
```
    Parameters:
    
    kind - kind or null for none
  - getName
```
public String getName()
```
    User-assigned name for this policy.
    
    Returns:
    
    value or null for none
  - setName
```
public Policy setName(String name)
```
    User-assigned name for this policy.
    
    Parameters:
    
    name - name or null for none
  - getNetworks
```
public List<PolicyNetwork> getNetworks()
```
    List of network names specifying networks to which this policy is applied.
    
    Returns:
    
    value or null for none
  - setNetworks
```
public Policy setNetworks(List<PolicyNetwork> networks)
```
    List of network names specifying networks to which this policy is applied.
    
    Parameters:
    
    networks - networks or null for none
  - set
```
public Policy set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Policy clone()
```
    Overrides:
    
    clone in class GenericJson

Class Policy

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Policy

Method Detail

getAlternativeNameServerConfig

setAlternativeNameServerConfig

getDescription

setDescription

getEnableInboundForwarding

setEnableInboundForwarding

getEnableLogging

setEnableLogging

getId

setId

getKind

setKind

getName

setName

getNetworks

setNetworks

set

clone