Class PublicAdvertisedPrefix (1.55.0)

public final class PublicAdvertisedPrefix extends GeneratedMessageV3 implements PublicAdvertisedPrefixOrBuilder

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.

Protobuf type google.cloud.compute.v1.PublicAdvertisedPrefix

Static Fields

BYOIP_API_VERSION_FIELD_NUMBER

public static final int BYOIP_API_VERSION_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DNS_VERIFICATION_IP_FIELD_NUMBER

public static final int DNS_VERIFICATION_IP_FIELD_NUMBER
Field Value
Type Description
int

FINGERPRINT_FIELD_NUMBER

public static final int FINGERPRINT_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

IP_CIDR_RANGE_FIELD_NUMBER

public static final int IP_CIDR_RANGE_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PDP_SCOPE_FIELD_NUMBER

public static final int PDP_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

PUBLIC_DELEGATED_PREFIXS_FIELD_NUMBER

public static final int PUBLIC_DELEGATED_PREFIXS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

SHARED_SECRET_FIELD_NUMBER

public static final int SHARED_SECRET_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PublicAdvertisedPrefix getDefaultInstance()
Returns
Type Description
PublicAdvertisedPrefix

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PublicAdvertisedPrefix.Builder newBuilder()
Returns
Type Description
PublicAdvertisedPrefix.Builder

newBuilder(PublicAdvertisedPrefix prototype)

public static PublicAdvertisedPrefix.Builder newBuilder(PublicAdvertisedPrefix prototype)
Parameter
Name Description
prototype PublicAdvertisedPrefix
Returns
Type Description
PublicAdvertisedPrefix.Builder

parseDelimitedFrom(InputStream input)

public static PublicAdvertisedPrefix parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublicAdvertisedPrefix parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PublicAdvertisedPrefix parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PublicAdvertisedPrefix parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PublicAdvertisedPrefix parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PublicAdvertisedPrefix parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PublicAdvertisedPrefix parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PublicAdvertisedPrefix parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PublicAdvertisedPrefix parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublicAdvertisedPrefix parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PublicAdvertisedPrefix parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PublicAdvertisedPrefix parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicAdvertisedPrefix
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PublicAdvertisedPrefix> parser()
Returns
Type Description
Parser<PublicAdvertisedPrefix>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getByoipApiVersion()

public String getByoipApiVersion()

[Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.

optional string byoip_api_version = 162683283;

Returns
Type Description
String

The byoipApiVersion.

getByoipApiVersionBytes()

public ByteString getByoipApiVersionBytes()

[Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.

optional string byoip_api_version = 162683283;

Returns
Type Description
ByteString

The bytes for byoipApiVersion.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public PublicAdvertisedPrefix getDefaultInstanceForType()
Returns
Type Description
PublicAdvertisedPrefix

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDnsVerificationIp()

public String getDnsVerificationIp()

The address to be used for reverse DNS verification.

optional string dns_verification_ip = 241011381;

Returns
Type Description
String

The dnsVerificationIp.

getDnsVerificationIpBytes()

public ByteString getDnsVerificationIpBytes()

The address to be used for reverse DNS verification.

optional string dns_verification_ip = 241011381;

Returns
Type Description
ByteString

The bytes for dnsVerificationIp.

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.

optional string fingerprint = 234678500;

Returns
Type Description
String

The fingerprint.

getFingerprintBytes()

public ByteString getFingerprintBytes()

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.

optional string fingerprint = 234678500;

Returns
Type Description
ByteString

The bytes for fingerprint.

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getIpCidrRange()

public String getIpCidrRange()

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

optional string ip_cidr_range = 98117322;

Returns
Type Description
String

The ipCidrRange.

getIpCidrRangeBytes()

public ByteString getIpCidrRangeBytes()

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

optional string ip_cidr_range = 98117322;

Returns
Type Description
ByteString

The bytes for ipCidrRange.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

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

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<PublicAdvertisedPrefix> getParserForType()
Returns
Type Description
Parser<PublicAdvertisedPrefix>
Overrides

getPdpScope()

public String getPdpScope()

Specifies how child public delegated prefix will be scoped. It could be one of following values: - REGIONAL: The public delegated prefix is regional only. The provisioning will take a few minutes. - GLOBAL: The public delegated prefix is global only. The provisioning will take ~4 weeks. - GLOBAL_AND_REGIONAL [output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2. Check the PdpScope enum for the list of possible values.

optional string pdp_scope = 524264785;

Returns
Type Description
String

The pdpScope.

getPdpScopeBytes()

public ByteString getPdpScopeBytes()

Specifies how child public delegated prefix will be scoped. It could be one of following values: - REGIONAL: The public delegated prefix is regional only. The provisioning will take a few minutes. - GLOBAL: The public delegated prefix is global only. The provisioning will take ~4 weeks. - GLOBAL_AND_REGIONAL [output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2. Check the PdpScope enum for the list of possible values.

optional string pdp_scope = 524264785;

Returns
Type Description
ByteString

The bytes for pdpScope.

getPublicDelegatedPrefixs(int index)

public PublicAdvertisedPrefixPublicDelegatedPrefix getPublicDelegatedPrefixs(int index)

[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

repeated .google.cloud.compute.v1.PublicAdvertisedPrefixPublicDelegatedPrefix public_delegated_prefixs = 425811723;

Parameter
Name Description
index int
Returns
Type Description
PublicAdvertisedPrefixPublicDelegatedPrefix

getPublicDelegatedPrefixsCount()

public int getPublicDelegatedPrefixsCount()

[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

repeated .google.cloud.compute.v1.PublicAdvertisedPrefixPublicDelegatedPrefix public_delegated_prefixs = 425811723;

Returns
Type Description
int

getPublicDelegatedPrefixsList()

public List<PublicAdvertisedPrefixPublicDelegatedPrefix> getPublicDelegatedPrefixsList()

[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

repeated .google.cloud.compute.v1.PublicAdvertisedPrefixPublicDelegatedPrefix public_delegated_prefixs = 425811723;

Returns
Type Description
List<PublicAdvertisedPrefixPublicDelegatedPrefix>

getPublicDelegatedPrefixsOrBuilder(int index)

public PublicAdvertisedPrefixPublicDelegatedPrefixOrBuilder getPublicDelegatedPrefixsOrBuilder(int index)

[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

repeated .google.cloud.compute.v1.PublicAdvertisedPrefixPublicDelegatedPrefix public_delegated_prefixs = 425811723;

Parameter
Name Description
index int
Returns
Type Description
PublicAdvertisedPrefixPublicDelegatedPrefixOrBuilder

getPublicDelegatedPrefixsOrBuilderList()

public List<? extends PublicAdvertisedPrefixPublicDelegatedPrefixOrBuilder> getPublicDelegatedPrefixsOrBuilderList()

[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

repeated .google.cloud.compute.v1.PublicAdvertisedPrefixPublicDelegatedPrefix public_delegated_prefixs = 425811723;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.PublicAdvertisedPrefixPublicDelegatedPrefixOrBuilder>
public String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSharedSecret()

public String getSharedSecret()

[Output Only] The shared secret to be used for reverse DNS verification.

optional string shared_secret = 381932490;

Returns
Type Description
String

The sharedSecret.

getSharedSecretBytes()

public ByteString getSharedSecretBytes()

[Output Only] The shared secret to be used for reverse DNS verification.

optional string shared_secret = 381932490;

Returns
Type Description
ByteString

The bytes for sharedSecret.

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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
ByteString

The bytes for status.

hasByoipApiVersion()

public boolean hasByoipApiVersion()

[Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.

optional string byoip_api_version = 162683283;

Returns
Type Description
boolean

Whether the byoipApiVersion field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDnsVerificationIp()

public boolean hasDnsVerificationIp()

The address to be used for reverse DNS verification.

optional string dns_verification_ip = 241011381;

Returns
Type Description
boolean

Whether the dnsVerificationIp field is set.

hasFingerprint()

public boolean hasFingerprint()

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.

optional string fingerprint = 234678500;

Returns
Type Description
boolean

Whether the fingerprint field is set.

hasId()

public boolean hasId()

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

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasIpCidrRange()

public boolean hasIpCidrRange()

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

optional string ip_cidr_range = 98117322;

Returns
Type Description
boolean

Whether the ipCidrRange field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

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

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasPdpScope()

public boolean hasPdpScope()

Specifies how child public delegated prefix will be scoped. It could be one of following values: - REGIONAL: The public delegated prefix is regional only. The provisioning will take a few minutes. - GLOBAL: The public delegated prefix is global only. The provisioning will take ~4 weeks. - GLOBAL_AND_REGIONAL [output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2. Check the PdpScope enum for the list of possible values.

optional string pdp_scope = 524264785;

Returns
Type Description
boolean

Whether the pdpScope field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSharedSecret()

public boolean hasSharedSecret()

[Output Only] The shared secret to be used for reverse DNS verification.

optional string shared_secret = 381932490;

Returns
Type Description
boolean

Whether the sharedSecret field is set.

hasStatus()

public boolean hasStatus()

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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PublicAdvertisedPrefix.Builder newBuilderForType()
Returns
Type Description
PublicAdvertisedPrefix.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PublicAdvertisedPrefix.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PublicAdvertisedPrefix.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PublicAdvertisedPrefix.Builder toBuilder()
Returns
Type Description
PublicAdvertisedPrefix.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException