Class PublicDelegatedPrefix (1.46.0)

public final class PublicDelegatedPrefix extends GeneratedMessageV3 implements PublicDelegatedPrefixOrBuilder

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.

Protobuf type google.cloud.compute.v1.PublicDelegatedPrefix

Static Fields

BYOIP_API_VERSION_FIELD_NUMBER

public static final int BYOIP_API_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

FINGERPRINT_FIELD_NUMBER

public static final int FINGERPRINT_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

IP_CIDR_RANGE_FIELD_NUMBER

public static final int IP_CIDR_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

IS_LIVE_MIGRATION_FIELD_NUMBER

public static final int IS_LIVE_MIGRATION_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_PREFIX_FIELD_NUMBER

public static final int PARENT_PREFIX_FIELD_NUMBER
Field Value
TypeDescription
int

PUBLIC_DELEGATED_SUB_PREFIXS_FIELD_NUMBER

public static final int PUBLIC_DELEGATED_SUB_PREFIXS_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PublicDelegatedPrefix getDefaultInstance()
Returns
TypeDescription
PublicDelegatedPrefix

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PublicDelegatedPrefix.Builder newBuilder()
Returns
TypeDescription
PublicDelegatedPrefix.Builder

newBuilder(PublicDelegatedPrefix prototype)

public static PublicDelegatedPrefix.Builder newBuilder(PublicDelegatedPrefix prototype)
Parameter
NameDescription
prototypePublicDelegatedPrefix
Returns
TypeDescription
PublicDelegatedPrefix.Builder

parseDelimitedFrom(InputStream input)

public static PublicDelegatedPrefix parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublicDelegatedPrefix parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PublicDelegatedPrefix parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PublicDelegatedPrefix parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PublicDelegatedPrefix parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PublicDelegatedPrefix parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PublicDelegatedPrefix parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PublicDelegatedPrefix parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PublicDelegatedPrefix parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublicDelegatedPrefix parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PublicDelegatedPrefix parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PublicDelegatedPrefix parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PublicDelegatedPrefix
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PublicDelegatedPrefix> parser()
Returns
TypeDescription
Parser<PublicDelegatedPrefix>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for byoipApiVersion.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public PublicDelegatedPrefix getDefaultInstanceForType()
Returns
TypeDescription
PublicDelegatedPrefix

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

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.

optional string fingerprint = 234678500;

Returns
TypeDescription
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 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.

optional string fingerprint = 234678500;

Returns
TypeDescription
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
TypeDescription
long

The id.

getIpCidrRange()

public String getIpCidrRange()

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

optional string ip_cidr_range = 98117322;

Returns
TypeDescription
String

The ipCidrRange.

getIpCidrRangeBytes()

public ByteString getIpCidrRangeBytes()

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

optional string ip_cidr_range = 98117322;

Returns
TypeDescription
ByteString

The bytes for ipCidrRange.

getIsLiveMigration()

public boolean getIsLiveMigration()

If true, the prefix will be live migrated.

optional bool is_live_migration = 511823856;

Returns
TypeDescription
boolean

The isLiveMigration.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParentPrefix()

public String getParentPrefix()

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

optional string parent_prefix = 15233991;

Returns
TypeDescription
String

The parentPrefix.

getParentPrefixBytes()

public ByteString getParentPrefixBytes()

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

optional string parent_prefix = 15233991;

Returns
TypeDescription
ByteString

The bytes for parentPrefix.

getParserForType()

public Parser<PublicDelegatedPrefix> getParserForType()
Returns
TypeDescription
Parser<PublicDelegatedPrefix>
Overrides

getPublicDelegatedSubPrefixs(int index)

public PublicDelegatedPrefixPublicDelegatedSubPrefix getPublicDelegatedSubPrefixs(int index)

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

repeated .google.cloud.compute.v1.PublicDelegatedPrefixPublicDelegatedSubPrefix public_delegated_sub_prefixs = 188940044;

Parameter
NameDescription
indexint
Returns
TypeDescription
PublicDelegatedPrefixPublicDelegatedSubPrefix

getPublicDelegatedSubPrefixsCount()

public int getPublicDelegatedSubPrefixsCount()

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

repeated .google.cloud.compute.v1.PublicDelegatedPrefixPublicDelegatedSubPrefix public_delegated_sub_prefixs = 188940044;

Returns
TypeDescription
int

getPublicDelegatedSubPrefixsList()

public List<PublicDelegatedPrefixPublicDelegatedSubPrefix> getPublicDelegatedSubPrefixsList()

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

repeated .google.cloud.compute.v1.PublicDelegatedPrefixPublicDelegatedSubPrefix public_delegated_sub_prefixs = 188940044;

Returns
TypeDescription
List<PublicDelegatedPrefixPublicDelegatedSubPrefix>

getPublicDelegatedSubPrefixsOrBuilder(int index)

public PublicDelegatedPrefixPublicDelegatedSubPrefixOrBuilder getPublicDelegatedSubPrefixsOrBuilder(int index)

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

repeated .google.cloud.compute.v1.PublicDelegatedPrefixPublicDelegatedSubPrefix public_delegated_sub_prefixs = 188940044;

Parameter
NameDescription
indexint
Returns
TypeDescription
PublicDelegatedPrefixPublicDelegatedSubPrefixOrBuilder

getPublicDelegatedSubPrefixsOrBuilderList()

public List<? extends PublicDelegatedPrefixPublicDelegatedSubPrefixOrBuilder> getPublicDelegatedSubPrefixsOrBuilderList()

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

repeated .google.cloud.compute.v1.PublicDelegatedPrefixPublicDelegatedSubPrefix public_delegated_sub_prefixs = 188940044;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.PublicDelegatedPrefixPublicDelegatedSubPrefixOrBuilder>

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.

optional string region = 138946292;

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
TypeDescription
ByteString

The bytes for region.

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

optional string status = 181260274;

Returns
TypeDescription
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

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

optional string status = 181260274;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the description 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 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.

optional string fingerprint = 234678500;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the id field is set.

hasIpCidrRange()

public boolean hasIpCidrRange()

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

optional string ip_cidr_range = 98117322;

Returns
TypeDescription
boolean

Whether the ipCidrRange field is set.

hasIsLiveMigration()

public boolean hasIsLiveMigration()

If true, the prefix will be live migrated.

optional bool is_live_migration = 511823856;

Returns
TypeDescription
boolean

Whether the isLiveMigration field is set.

hasKind()

public boolean hasKind()

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

optional string kind = 3292052;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the name field is set.

hasParentPrefix()

public boolean hasParentPrefix()

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

optional string parent_prefix = 15233991;

Returns
TypeDescription
boolean

Whether the parentPrefix field is set.

hasRegion()

public boolean hasRegion()

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

optional string region = 138946292;

Returns
TypeDescription
boolean

Whether the region field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasStatus()

public boolean hasStatus()

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

optional string status = 181260274;

Returns
TypeDescription
boolean

Whether the status field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PublicDelegatedPrefix.Builder newBuilderForType()
Returns
TypeDescription
PublicDelegatedPrefix.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PublicDelegatedPrefix.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PublicDelegatedPrefix.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PublicDelegatedPrefix.Builder toBuilder()
Returns
TypeDescription
PublicDelegatedPrefix.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException