PublicAdvertisedPrefix (Compute Engine API beta-rev20220726-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class PublicAdvertisedPrefix
extends GenericJson
```
A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.
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
  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

PublicAdvertisedPrefix()

Constructors
Constructor and Description
`PublicAdvertisedPrefix()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PublicAdvertisedPrefix`	`clone()`
`byte[]`	`decodeFingerprint()` Fingerprint of this resource.
`PublicAdvertisedPrefix`	`encodeFingerprint(byte[] fingerprint)` Fingerprint of this resource.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`String`	`getDnsVerificationIp()` The IPv4 address to be used for reverse DNS verification.
`String`	`getFingerprint()` Fingerprint of this resource.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource type.
`String`	`getIpCidrRange()` The IPv4 address range, in CIDR format, represented by this public advertised prefix.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getName()` Name of the resource.
`List<PublicAdvertisedPrefixPublicDelegatedPrefix>`	`getPublicDelegatedPrefixs()` [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getSharedSecret()` [Output Only] The shared secret to be used for reverse DNS verification.
`String`	`getStatus()` The status of the public advertised prefix.
`PublicAdvertisedPrefix`	`set(String fieldName, Object value)`
`PublicAdvertisedPrefix`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`PublicAdvertisedPrefix`	`setDescription(String description)` An optional description of this resource.
`PublicAdvertisedPrefix`	`setDnsVerificationIp(String dnsVerificationIp)` The IPv4 address to be used for reverse DNS verification.
`PublicAdvertisedPrefix`	`setFingerprint(String fingerprint)` Fingerprint of this resource.
`PublicAdvertisedPrefix`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource type.
`PublicAdvertisedPrefix`	`setIpCidrRange(String ipCidrRange)` The IPv4 address range, in CIDR format, represented by this public advertised prefix.
`PublicAdvertisedPrefix`	`setKind(String kind)` [Output Only] Type of the resource.
`PublicAdvertisedPrefix`	`setName(String name)` Name of the resource.
`PublicAdvertisedPrefix`	`setPublicDelegatedPrefixs(List<PublicAdvertisedPrefixPublicDelegatedPrefix> publicDelegatedPrefixs)` [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
`PublicAdvertisedPrefix`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`PublicAdvertisedPrefix`	`setSharedSecret(String sharedSecret)` [Output Only] The shared secret to be used for reverse DNS verification.
`PublicAdvertisedPrefix`	`setStatus(String status)` The status of the public advertised prefix.

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
  - PublicAdvertisedPrefix
```
public PublicAdvertisedPrefix()
```
- Method Detail
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public PublicAdvertisedPrefix 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 PublicAdvertisedPrefix setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getDnsVerificationIp
```
public String getDnsVerificationIp()
```
    The IPv4 address to be used for reverse DNS verification.
    
    Returns:
    
    value or null for none
  - setDnsVerificationIp
```
public PublicAdvertisedPrefix setDnsVerificationIp(String dnsVerificationIp)
```
    The IPv4 address to be used for reverse DNS verification.
    
    Parameters:
    
    dnsVerificationIp - dnsVerificationIp 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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
    
    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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getFingerprint()
  - setFingerprint
```
public PublicAdvertisedPrefix 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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
    
    Parameters:
    
    fingerprint - fingerprint or null for none
    
    See Also:
    
    #encodeFingerprint()
  - encodeFingerprint
```
public PublicAdvertisedPrefix 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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
    
    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 PublicAdvertisedPrefix 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 IPv4 address range, in CIDR format, represented by this public advertised prefix.
    
    Returns:
    
    value or null for none
  - setIpCidrRange
```
public PublicAdvertisedPrefix setIpCidrRange(String ipCidrRange)
```
    The IPv4 address range, in CIDR format, represented by this public advertised prefix.
    
    Parameters:
    
    ipCidrRange - ipCidrRange or null for none
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
    
    Returns:
    
    value or null for none
  - setKind
```
public PublicAdvertisedPrefix setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
    
    Parameters:
    
    kind - kind 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 PublicAdvertisedPrefix 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
  - getPublicDelegatedPrefixs
```
public List<PublicAdvertisedPrefixPublicDelegatedPrefix> getPublicDelegatedPrefixs()
```
    [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
    
    Returns:
    
    value or null for none
  - setPublicDelegatedPrefixs
```
public PublicAdvertisedPrefix setPublicDelegatedPrefixs(List<PublicAdvertisedPrefixPublicDelegatedPrefix> publicDelegatedPrefixs)
```
    [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
    
    Parameters:
    
    publicDelegatedPrefixs - publicDelegatedPrefixs or null for none
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public PublicAdvertisedPrefix setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getSharedSecret
```
public String getSharedSecret()
```
    [Output Only] The shared secret to be used for reverse DNS verification.
    
    Returns:
    
    value or null for none
  - setSharedSecret
```
public PublicAdvertisedPrefix setSharedSecret(String sharedSecret)
```
    [Output Only] The shared secret to be used for reverse DNS verification.
    
    Parameters:
    
    sharedSecret - sharedSecret or null for none
  - getStatus
```
public String getStatus()
```
    The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.
    
    Returns:
    
    value or null for none
  - setStatus
```
public PublicAdvertisedPrefix setStatus(String status)
```
    The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.
    
    Parameters:
    
    status - status or null for none
  - set
```
public PublicAdvertisedPrefix set(String fieldName,
                                  Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public PublicAdvertisedPrefix clone()
```
    Overrides:
    
    clone in class GenericJson

Class PublicAdvertisedPrefix

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

PublicAdvertisedPrefix

Method Detail

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getDnsVerificationIp

setDnsVerificationIp

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getId

setId

getIpCidrRange

setIpCidrRange

getKind

setKind

getName

setName

getPublicDelegatedPrefixs

setPublicDelegatedPrefixs

getSelfLink

setSelfLink

getSharedSecret

setSharedSecret

getStatus

setStatus

set

clone