com.google.api.services.compute.model

Class DhcpOptionsConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.DhcpOptionsConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DhcpOptionsConfig
extends com.google.api.client.json.GenericJson

A standalone, regional API resource that encapsulates a set of user-defined DHCP configurations.

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 Compute Engine 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

com.google.api.client.util.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
DhcpOptionsConfig()

Method Summary

Modifier and Type	Method and Description
DhcpOptionsConfig	clone()
Map<String,DhcpOptionsConfigAssociation>	getAssociations() Mapping of user-defined keys to DhcpOptionsConfig to Network associations.
String	getBootFileIpv4Name() The file path and name of the boot image/file on the TFTP server that the client VM guest OS should download and execute during network boot.
List<String>	getBootFileIpv6Parameters() A list of UTF-8 encoded parameter strings to be passed as arguments to the bootloader program or OS kernel after downloading the boot file.
String	getBootFileIpv6Url() The Uniform Resource Locator (URL) specifying the protocol, server address, and file path of the boot file that the client VM guest OS should download and execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or 'http://[2001:db8::1]/boot.img').
String	getCreationTimestamp() Output only.
String	getDescription() An optional description of this resource.
List<String>	getDnsSearchPaths() An ordered list of domain suffixes (search paths) that the client VM guest OS should append to resolve hostnames that are not fully qualified.
List<String>	getDnsServerIpv4Addresses() An ordered list of IPv4 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference.
List<String>	getDnsServerIpv6Addresses() An ordered list of IPv6 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference.
String	getDomainName() The domain name that the client VM guest OS should use when resolving hostnames via DNS (e.g., 'example.com').
BigInteger	getId() Output only.
String	getKind() Output only.
Long	getLeaseTimeSec() The duration, in seconds, of the IPv4 address lease offered by the DHCP server to the client VM guest OS.
String	getName() Name of the resource.
List<String>	getNtpServerIpv4Addresses() An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization, listed in order of preference.
List<String>	getNtpServerIpv6Addresses() An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization.
String	getRegion() Output only.
String	getSelfLink() Output only.
List<String>	getTftpServerIpv4Addresses() An ordered list of one or more IPv4 addresses of TFTP servers.
String	getTftpServerIpv4Name() The hostname or IP address of the Trivial File Transfer Protocol (TFTP) server from which the client VM guest OS can download boot files.
DhcpOptionsConfig	set(String fieldName, Object value)
DhcpOptionsConfig	setAssociations(Map<String,DhcpOptionsConfigAssociation> associations) Mapping of user-defined keys to DhcpOptionsConfig to Network associations.
DhcpOptionsConfig	setBootFileIpv4Name(String bootFileIpv4Name) The file path and name of the boot image/file on the TFTP server that the client VM guest OS should download and execute during network boot.
DhcpOptionsConfig	setBootFileIpv6Parameters(List<String> bootFileIpv6Parameters) A list of UTF-8 encoded parameter strings to be passed as arguments to the bootloader program or OS kernel after downloading the boot file.
DhcpOptionsConfig	setBootFileIpv6Url(String bootFileIpv6Url) The Uniform Resource Locator (URL) specifying the protocol, server address, and file path of the boot file that the client VM guest OS should download and execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or 'http://[2001:db8::1]/boot.img').
DhcpOptionsConfig	setCreationTimestamp(String creationTimestamp) Output only.
DhcpOptionsConfig	setDescription(String description) An optional description of this resource.
DhcpOptionsConfig	setDnsSearchPaths(List<String> dnsSearchPaths) An ordered list of domain suffixes (search paths) that the client VM guest OS should append to resolve hostnames that are not fully qualified.
DhcpOptionsConfig	setDnsServerIpv4Addresses(List<String> dnsServerIpv4Addresses) An ordered list of IPv4 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference.
DhcpOptionsConfig	setDnsServerIpv6Addresses(List<String> dnsServerIpv6Addresses) An ordered list of IPv6 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference.
DhcpOptionsConfig	setDomainName(String domainName) The domain name that the client VM guest OS should use when resolving hostnames via DNS (e.g., 'example.com').
DhcpOptionsConfig	setId(BigInteger id) Output only.
DhcpOptionsConfig	setKind(String kind) Output only.
DhcpOptionsConfig	setLeaseTimeSec(Long leaseTimeSec) The duration, in seconds, of the IPv4 address lease offered by the DHCP server to the client VM guest OS.
DhcpOptionsConfig	setName(String name) Name of the resource.
DhcpOptionsConfig	setNtpServerIpv4Addresses(List<String> ntpServerIpv4Addresses) An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization, listed in order of preference.
DhcpOptionsConfig	setNtpServerIpv6Addresses(List<String> ntpServerIpv6Addresses) An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization.
DhcpOptionsConfig	setRegion(String region) Output only.
DhcpOptionsConfig	setSelfLink(String selfLink) Output only.
DhcpOptionsConfig	setTftpServerIpv4Addresses(List<String> tftpServerIpv4Addresses) An ordered list of one or more IPv4 addresses of TFTP servers.
DhcpOptionsConfig	setTftpServerIpv4Name(String tftpServerIpv4Name) The hostname or IP address of the Trivial File Transfer Protocol (TFTP) server from which the client VM guest OS can download boot files.

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

DhcpOptionsConfig

public DhcpOptionsConfig()

Method Detail

getAssociations

public Map<String,DhcpOptionsConfigAssociation> getAssociations()

Mapping of user-defined keys to DhcpOptionsConfig to Network associations.

Returns:

value or null for none

setAssociations

public DhcpOptionsConfig setAssociations(Map<String,DhcpOptionsConfigAssociation> associations)

Mapping of user-defined keys to DhcpOptionsConfig to Network associations.

Parameters:

associations - associations or null for none

getBootFileIpv4Name

public String getBootFileIpv4Name()

The file path and name of the boot image/file on the TFTP server that the client VM guest OS should download and execute during network boot. Used when the standard DHCP header 'file' field is overloaded. Corresponds to DHCPv4 Option 67.

Returns:

value or null for none

setBootFileIpv4Name

public DhcpOptionsConfig setBootFileIpv4Name(String bootFileIpv4Name)

The file path and name of the boot image/file on the TFTP server that the client VM guest OS should download and execute during network boot. Used when the standard DHCP header 'file' field is overloaded. Corresponds to DHCPv4 Option 67.

Parameters:

bootFileIpv4Name - bootFileIpv4Name or null for none

getBootFileIpv6Parameters

public List<String> getBootFileIpv6Parameters()

A list of UTF-8 encoded parameter strings to be passed as arguments to the bootloader program or OS kernel after downloading the boot file. Corresponds to DHCPv6 Option 60.

Returns:

value or null for none

setBootFileIpv6Parameters

public DhcpOptionsConfig setBootFileIpv6Parameters(List<String> bootFileIpv6Parameters)

A list of UTF-8 encoded parameter strings to be passed as arguments to the bootloader program or OS kernel after downloading the boot file. Corresponds to DHCPv6 Option 60.

Parameters:

bootFileIpv6Parameters - bootFileIpv6Parameters or null for none

getBootFileIpv6Url

public String getBootFileIpv6Url()

The Uniform Resource Locator (URL) specifying the protocol, server address, and file path of the boot file that the client VM guest OS should download and execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or 'http://[2001:db8::1]/boot.img'). Corresponds to DHCPv6 Option 59.

Returns:

value or null for none

setBootFileIpv6Url

public DhcpOptionsConfig setBootFileIpv6Url(String bootFileIpv6Url)

The Uniform Resource Locator (URL) specifying the protocol, server address, and file path of the boot file that the client VM guest OS should download and execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or 'http://[2001:db8::1]/boot.img'). Corresponds to DHCPv6 Option 59.

Parameters:

bootFileIpv6Url - bootFileIpv6Url or null for none

getCreationTimestamp

public String getCreationTimestamp()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public DhcpOptionsConfig setCreationTimestamp(String creationTimestamp)

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Parameters:

creationTimestamp - creationTimestamp or null for none

getDescription

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

Returns:

value or null for none

setDescription

public DhcpOptionsConfig setDescription(String description)

An optional description of this resource. Provide this property when you create the resource.

Parameters:

description - description or null for none

getDnsSearchPaths

public List<String> getDnsSearchPaths()

An ordered list of domain suffixes (search paths) that the client VM guest OS should append to resolve hostnames that are not fully qualified. Applies to both DHCPv4 Option 119 and DHCPv6 Option 24.

Returns:

value or null for none

setDnsSearchPaths

public DhcpOptionsConfig setDnsSearchPaths(List<String> dnsSearchPaths)

An ordered list of domain suffixes (search paths) that the client VM guest OS should append to resolve hostnames that are not fully qualified. Applies to both DHCPv4 Option 119 and DHCPv6 Option 24.

Parameters:

dnsSearchPaths - dnsSearchPaths or null for none

getDnsServerIpv4Addresses

public List<String> getDnsServerIpv4Addresses()

An ordered list of IPv4 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference. Corresponds to DHCPv4 Option 6.

Returns:

value or null for none

setDnsServerIpv4Addresses

public DhcpOptionsConfig setDnsServerIpv4Addresses(List<String> dnsServerIpv4Addresses)

An ordered list of IPv4 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference. Corresponds to DHCPv4 Option 6.

Parameters:

dnsServerIpv4Addresses - dnsServerIpv4Addresses or null for none

getDnsServerIpv6Addresses

public List<String> getDnsServerIpv6Addresses()

An ordered list of IPv6 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference. Corresponds to DHCPv6 Option 23.

Returns:

value or null for none

setDnsServerIpv6Addresses

public DhcpOptionsConfig setDnsServerIpv6Addresses(List<String> dnsServerIpv6Addresses)

An ordered list of IPv6 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference. Corresponds to DHCPv6 Option 23.

Parameters:

dnsServerIpv6Addresses - dnsServerIpv6Addresses or null for none

getDomainName

public String getDomainName()

The domain name that the client VM guest OS should use when resolving hostnames via DNS (e.g., 'example.com'). It defines the default domain suffix for the client. Corresponds to DHCPv4 Option 15.

Returns:

value or null for none

setDomainName

public DhcpOptionsConfig setDomainName(String domainName)

The domain name that the client VM guest OS should use when resolving hostnames via DNS (e.g., 'example.com'). It defines the default domain suffix for the client. Corresponds to DHCPv4 Option 15.

Parameters:

domainName - domainName or null for none

getId

public BigInteger getId()

Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.

Returns:

value or null for none

setId

public DhcpOptionsConfig setId(BigInteger id)

Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.

Parameters:

id - id or null for none

getKind

public String getKind()

Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs.

Returns:

value or null for none

setKind

public DhcpOptionsConfig setKind(String kind)

Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs.

Parameters:

kind - kind or null for none

getLeaseTimeSec

public Long getLeaseTimeSec()

The duration, in seconds, of the IPv4 address lease offered by the DHCP server to the client VM guest OS. Corresponds to DHCPv4 Option 51.

Returns:

value or null for none

setLeaseTimeSec

public DhcpOptionsConfig setLeaseTimeSec(Long leaseTimeSec)

The duration, in seconds, of the IPv4 address lease offered by the DHCP server to the client VM guest OS. Corresponds to DHCPv4 Option 51.

Parameters:

leaseTimeSec - leaseTimeSec or null for none

getName

public String getName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns:

value or null for none

setName

public DhcpOptionsConfig setName(String name)

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameters:

name - name or null for none

getNtpServerIpv4Addresses

public List<String> getNtpServerIpv4Addresses()

An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization, listed in order of preference. Corresponds to DHCPv4 Option 42.

Returns:

value or null for none

setNtpServerIpv4Addresses

public DhcpOptionsConfig setNtpServerIpv4Addresses(List<String> ntpServerIpv4Addresses)

An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization, listed in order of preference. Corresponds to DHCPv4 Option 42.

Parameters:

ntpServerIpv4Addresses - ntpServerIpv4Addresses or null for none

getNtpServerIpv6Addresses

public List<String> getNtpServerIpv6Addresses()

An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization. Corresponds to DHCPv6 Option 56.

Returns:

value or null for none

setNtpServerIpv6Addresses

public DhcpOptionsConfig setNtpServerIpv6Addresses(List<String> ntpServerIpv6Addresses)

An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization. Corresponds to DHCPv6 Option 56.

Parameters:

ntpServerIpv6Addresses - ntpServerIpv6Addresses or null for none

getRegion

public String getRegion()

Output only. [Output Only] URL of the region where the resource resides.

Returns:

value or null for none

setRegion

public DhcpOptionsConfig setRegion(String region)

Output only. [Output Only] URL of the region where the resource resides.

Parameters:

region - region or null for none

getSelfLink

public String getSelfLink()

Output only. [Output Only] Server-defined URL for the resource.

Returns:

value or null for none

setSelfLink

public DhcpOptionsConfig setSelfLink(String selfLink)

Output only. [Output Only] Server-defined URL for the resource.

Parameters:

selfLink - selfLink or null for none

getTftpServerIpv4Addresses

public List<String> getTftpServerIpv4Addresses()

An ordered list of one or more IPv4 addresses of TFTP servers. Provides server redundancy and failover support, and is generally prioritized by clients over the single hostname specified in Option 66. Corresponds to DHCPv4 Option 150.

Returns:

value or null for none

setTftpServerIpv4Addresses

public DhcpOptionsConfig setTftpServerIpv4Addresses(List<String> tftpServerIpv4Addresses)

An ordered list of one or more IPv4 addresses of TFTP servers. Provides server redundancy and failover support, and is generally prioritized by clients over the single hostname specified in Option 66. Corresponds to DHCPv4 Option 150.

Parameters:

tftpServerIpv4Addresses - tftpServerIpv4Addresses or null for none

getTftpServerIpv4Name

public String getTftpServerIpv4Name()

The hostname or IP address of the Trivial File Transfer Protocol (TFTP) server from which the client VM guest OS can download boot files. Typically used in network booting (PXE) when the standard DHCP header 'sname' field is overloaded. Corresponds to DHCPv4 Option 66.

Returns:

value or null for none

setTftpServerIpv4Name

public DhcpOptionsConfig setTftpServerIpv4Name(String tftpServerIpv4Name)

The hostname or IP address of the Trivial File Transfer Protocol (TFTP) server from which the client VM guest OS can download boot files. Typically used in network booting (PXE) when the standard DHCP header 'sname' field is overloaded. Corresponds to DHCPv4 Option 66.

Parameters:

tftpServerIpv4Name - tftpServerIpv4Name or null for none

set

public DhcpOptionsConfig set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public DhcpOptionsConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson