PublicAdvertisedPrefix

JSON representation
Status
PdpScope
PublicDelegatedPrefix
- JSON representation
ByoipApiVersion
Ipv6AccessType

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.

JSON representation

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "selfLink": string, "ipCidrRange": string, "dnsVerificationIp": string, "sharedSecret": string, "status": enum (`Status`), "pdpScope": enum (`PdpScope`), "publicDelegatedPrefixs": [ { object (`PublicDelegatedPrefix`) } ], "fingerprint": string, "byoipApiVersion": enum (`ByoipApiVersion`), "networkTier": enum (`NetworkTier`), "ipv6AccessType": enum (`Ipv6AccessType`) }

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "ipCidrRange": string,
  "dnsVerificationIp": string,
  "sharedSecret": string,
  "status": enum (Status),
  "pdpScope": enum (PdpScope),
  "publicDelegatedPrefixs": [
    {
      object (PublicDelegatedPrefix)
    }
  ],
  "fingerprint": string,
  "byoipApiVersion": enum (ByoipApiVersion),
  "networkTier": enum (NetworkTier),
  "ipv6AccessType": enum (Ipv6AccessType)
}

Fields
`kind`	`string` Output only. Type of the resource. Always `compute#publicAdvertisedPrefix` for public advertised prefixes.
`id`	`string (uint64 format)` Output only. The unique identifier for the resource type. The server generates this identifier.
`creationTimestamp`	`string` Output only. Creation timestamp in RFC3339 text format.
`name`	`string` 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.
`description`	`string` An optional description of this resource. Provide this property when you create the resource.
`selfLink`	`string` Output only. Server-defined URL for the resource.
`ipCidrRange`	`string` The address range, in CIDR format, represented by this public advertised prefix.
`dnsVerificationIp`	`string` The address to be used for reverse DNS verification.
`sharedSecret`	`string` Output only. The shared secret to be used for reverse DNS verification.
`status`	`enum (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.
`pdpScope`	`enum (PdpScope)` 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.
`publicDelegatedPrefixs[]`	`object (PublicDelegatedPrefix)` Output only. The list of public delegated prefixes that exist for this public advertised prefix.
`fingerprint`	`string (bytes format)` 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. A base64-encoded string.
`byoipApiVersion`	`enum (ByoipApiVersion)` Output only. The version of BYOIP API.
`networkTier`	`enum (NetworkTier)` Network tier to be used for this prefix. All child delegated prefixes will inherit this field. If this field is not specified, it defaults to the network tier of the project that the PublicAdvertisedPrefix belongs to.
`ipv6AccessType`	`enum (Ipv6AccessType)` The internet access type for IPv6 Public Advertised Prefixes.

Status

The provisioning status of the public advertised prefix.

Enums
`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.
`READY_TO_ANNOUNCE`	The prefix is currently withdrawn but ready to be announced.
`ANNOUNCED_TO_INTERNET`	The prefix is announced to Internet.

PdpScope

Enums
`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`	The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2.

PublicDelegatedPrefix

Represents a CIDR range which can be used to assign addresses.

JSON representation
{ "name": string, "region": string, "project": string, "status": string, "ipRange": string }

Fields
`name`	`string` The name of the public delegated prefix
`region`	`string` The region of the public delegated prefix if it is regional. If absent, the prefix is global.
`project`	`string` The project number of the public delegated prefix
`status`	`string` The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.
`ipRange`	`string` The IP address range of the public delegated prefix

ByoipApiVersion

The version of BYOIP API

Enums
`V1`	This public advertised prefix can be used to create both regional and global public delegated prefixes. It usually takes 4 weeks to create or delete a public delegated prefix. The BGP status cannot be changed.
`V2`	This public advertised prefix can only be used to create regional public delegated prefixes. Public delegated prefix creation and deletion takes minutes and the BGP status can be modified.

Ipv6AccessType

The internet access type for IPv6 Public Advertised Prefixes.

Enums
`EXTERNAL`	Default IPv6 access type. The prefix will be announced to the internet. All children Public Delegated Prefixes will have IPv6 access type as EXTERNAL.
`INTERNAL`	The prefix will not be announced to the internet. Prefix will be used privately within Cloud. All children Public Delegated Prefixes will have IPv6 access type as INTERNAL.