com.google.api.services.compute.model

Class PublicDelegatedPrefix

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.PublicDelegatedPrefix

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.

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
PublicDelegatedPrefix()

Method Summary

Modifier and Type	Method and Description
PublicDelegatedPrefix	clone()
byte[]	decodeFingerprint() Fingerprint of this resource.
PublicDelegatedPrefix	encodeFingerprint(byte[] fingerprint) Fingerprint of this resource.
Integer	getAllocatablePrefixLength() The allocatable prefix length supported by this public delegated prefix.
String	getByoipApiVersion() [Output Only] The version of BYOIP API.
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
String	getDescription() An optional description of this resource.
String	getFingerprint() Fingerprint of this resource.
BigInteger	getId() [Output Only] The unique identifier for the resource type.
String	getIpCidrRange() The IP address range, in CIDR format, represented by this public delegated prefix.
Boolean	getIsLiveMigration() If true, the prefix will be live migrated.
String	getKind() [Output Only] Type of the resource.
String	getMode() The public delegated prefix mode for IPv6 only.
String	getName() Name of the resource.
String	getParentPrefix() The URL of parent prefix.
List<PublicDelegatedPrefixPublicDelegatedSubPrefix>	getPublicDelegatedSubPrefixs() The list of sub public delegated prefixes that exist for this public delegated prefix.
String	getRegion() [Output Only] URL of the region where the public delegated prefix resides.
String	getSelfLink() [Output Only] Server-defined URL for the resource.
String	getStatus() [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet.
PublicDelegatedPrefix	set(String fieldName, Object value)
PublicDelegatedPrefix	setAllocatablePrefixLength(Integer allocatablePrefixLength) The allocatable prefix length supported by this public delegated prefix.
PublicDelegatedPrefix	setByoipApiVersion(String byoipApiVersion) [Output Only] The version of BYOIP API.
PublicDelegatedPrefix	setCreationTimestamp(String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
PublicDelegatedPrefix	setDescription(String description) An optional description of this resource.
PublicDelegatedPrefix	setFingerprint(String fingerprint) Fingerprint of this resource.
PublicDelegatedPrefix	setId(BigInteger id) [Output Only] The unique identifier for the resource type.
PublicDelegatedPrefix	setIpCidrRange(String ipCidrRange) The IP address range, in CIDR format, represented by this public delegated prefix.
PublicDelegatedPrefix	setIsLiveMigration(Boolean isLiveMigration) If true, the prefix will be live migrated.
PublicDelegatedPrefix	setKind(String kind) [Output Only] Type of the resource.
PublicDelegatedPrefix	setMode(String mode) The public delegated prefix mode for IPv6 only.
PublicDelegatedPrefix	setName(String name) Name of the resource.
PublicDelegatedPrefix	setParentPrefix(String parentPrefix) The URL of parent prefix.
PublicDelegatedPrefix	setPublicDelegatedSubPrefixs(List<PublicDelegatedPrefixPublicDelegatedSubPrefix> publicDelegatedSubPrefixs) The list of sub public delegated prefixes that exist for this public delegated prefix.
PublicDelegatedPrefix	setRegion(String region) [Output Only] URL of the region where the public delegated prefix resides.
PublicDelegatedPrefix	setSelfLink(String selfLink) [Output Only] Server-defined URL for the resource.
PublicDelegatedPrefix	setStatus(String status) [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet.

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

PublicDelegatedPrefix

public PublicDelegatedPrefix()

Method Detail

getAllocatablePrefixLength

public Integer getAllocatablePrefixLength()

The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.

Returns:

value or null for none

setAllocatablePrefixLength

public PublicDelegatedPrefix setAllocatablePrefixLength(Integer allocatablePrefixLength)

The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.

Parameters:

allocatablePrefixLength - allocatablePrefixLength or null for none

getByoipApiVersion

public String getByoipApiVersion()

[Output Only] The version of BYOIP API.

Returns:

value or null for none

setByoipApiVersion

public PublicDelegatedPrefix setByoipApiVersion(String byoipApiVersion)

[Output Only] The version of BYOIP API.

Parameters:

byoipApiVersion - byoipApiVersion or null for none

getCreationTimestamp

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public PublicDelegatedPrefix setCreationTimestamp(String creationTimestamp)

[Output Only] Creation timestamp in RFC3339 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 PublicDelegatedPrefix setDescription(String description)

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

Parameters:

description - description or null for none

getFingerprint

public String getFingerprint()

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.

Returns:

value or null for none

See Also:

decodeFingerprint()

decodeFingerprint

public byte[] decodeFingerprint()

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getFingerprint()

setFingerprint

public PublicDelegatedPrefix setFingerprint(String fingerprint)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.

Parameters:

fingerprint - fingerprint or null for none

See Also:

#encodeFingerprint()

encodeFingerprint

public PublicDelegatedPrefix encodeFingerprint(byte[] fingerprint)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getId

public BigInteger getId()

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

Returns:

value or null for none

setId

public PublicDelegatedPrefix setId(BigInteger id)

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

Parameters:

id - id or null for none

getIpCidrRange

public String getIpCidrRange()

The IP address range, in CIDR format, represented by this public delegated prefix.

Returns:

value or null for none

setIpCidrRange

public PublicDelegatedPrefix setIpCidrRange(String ipCidrRange)

The IP address range, in CIDR format, represented by this public delegated prefix.

Parameters:

ipCidrRange - ipCidrRange or null for none

getIsLiveMigration

public Boolean getIsLiveMigration()

If true, the prefix will be live migrated.

Returns:

value or null for none

setIsLiveMigration

public PublicDelegatedPrefix setIsLiveMigration(Boolean isLiveMigration)

If true, the prefix will be live migrated.

Parameters:

isLiveMigration - isLiveMigration or null for none

getKind

public String getKind()

[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.

Returns:

value or null for none

setKind

public PublicDelegatedPrefix setKind(String kind)

[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.

Parameters:

kind - kind or null for none

getMode

public String getMode()

The public delegated prefix mode for IPv6 only.

Returns:

value or null for none

setMode

public PublicDelegatedPrefix setMode(String mode)

The public delegated prefix mode for IPv6 only.

Parameters:

mode - mode 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 with RFC1035. 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 PublicDelegatedPrefix 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 with RFC1035. 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

getParentPrefix

public String getParentPrefix()

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

Returns:

value or null for none

setParentPrefix

public PublicDelegatedPrefix setParentPrefix(String parentPrefix)

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

Parameters:

parentPrefix - parentPrefix or null for none

getPublicDelegatedSubPrefixs

public List<PublicDelegatedPrefixPublicDelegatedSubPrefix> getPublicDelegatedSubPrefixs()

The list of sub public delegated prefixes that exist for this public delegated prefix.

Returns:

value or null for none

setPublicDelegatedSubPrefixs

public PublicDelegatedPrefix setPublicDelegatedSubPrefixs(List<PublicDelegatedPrefixPublicDelegatedSubPrefix> publicDelegatedSubPrefixs)

The list of sub public delegated prefixes that exist for this public delegated prefix.

Parameters:

publicDelegatedSubPrefixs - publicDelegatedSubPrefixs or null for none

getRegion

public String getRegion()

[Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns:

value or null for none

setRegion

public PublicDelegatedPrefix setRegion(String region)

[Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Parameters:

region - region or null for none

getSelfLink

public String getSelfLink()

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

Returns:

value or null for none

setSelfLink

public PublicDelegatedPrefix setSelfLink(String selfLink)

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

Parameters:

selfLink - selfLink or null for none

getStatus

public String getStatus()

[Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned.

Returns:

value or null for none

setStatus

public PublicDelegatedPrefix setStatus(String status)

[Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned.

Parameters:

status - status or null for none

set

public PublicDelegatedPrefix set(String fieldName,
                                 Object value)

Overrides:

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

clone

public PublicDelegatedPrefix clone()

Overrides:

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