Skip to main content

global_public_delegated_prefixes

Creates, updates, deletes, gets or lists a global_public_delegated_prefixes resource.

Overview

Nameglobal_public_delegated_prefixes
TypeResource
Idgoogle.compute.global_public_delegated_prefixes

Fields

NameDatatypeDescription
idstring[Output Only] The unique identifier for the resource type. The server generates this identifier.
namestringName 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.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
allocatablePrefixLengthintegerThe 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.
byoipApiVersionstring[Output Only] The version of BYOIP API.
creationTimestampstring[Output Only] Creation timestamp in RFC3339 text format.
fingerprintstringFingerprint 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.
ipCidrRangestringThe IP address range, in CIDR format, represented by this public delegated prefix.
isLiveMigrationbooleanIf true, the prefix will be live migrated.
kindstring[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
modestringThe public delegated prefix mode for IPv6 only.
parentPrefixstringThe URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
publicDelegatedSubPrefixsarrayThe list of sub public delegated prefixes that exist for this public delegated prefix.
regionstring[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.
selfLinkstring[Output Only] Server-defined URL for the resource.
statusstring[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.

Methods

NameAccessible byRequired ParamsDescription
getSELECTproject, publicDelegatedPrefixReturns the specified global PublicDelegatedPrefix resource.
listSELECTprojectLists the global PublicDelegatedPrefixes for a project.
insertINSERTprojectCreates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.
deleteDELETEproject, publicDelegatedPrefixDeletes the specified global PublicDelegatedPrefix.
patchUPDATEproject, publicDelegatedPrefixPatches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

SELECT examples

Lists the global PublicDelegatedPrefixes for a project.

SELECT
id,
name,
description,
allocatablePrefixLength,
byoipApiVersion,
creationTimestamp,
fingerprint,
ipCidrRange,
isLiveMigration,
kind,
mode,
parentPrefix,
publicDelegatedSubPrefixs,
region,
selfLink,
status
FROM google.compute.global_public_delegated_prefixes
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new global_public_delegated_prefixes resource.

/*+ create */
INSERT INTO google.compute.global_public_delegated_prefixes (
project,
name,
description,
region,
ipCidrRange,
status,
parentPrefix,
publicDelegatedSubPrefixs,
isLiveMigration,
fingerprint,
mode,
allocatablePrefixLength,
byoipApiVersion
)
SELECT
'{{ project }}',
'{{ name }}',
'{{ description }}',
'{{ region }}',
'{{ ipCidrRange }}',
'{{ status }}',
'{{ parentPrefix }}',
'{{ publicDelegatedSubPrefixs }}',
{{ isLiveMigration }},
'{{ fingerprint }}',
'{{ mode }}',
'{{ allocatablePrefixLength }}',
'{{ byoipApiVersion }}'
;

UPDATE example

Updates a global_public_delegated_prefixes resource.

/*+ update */
UPDATE google.compute.global_public_delegated_prefixes
SET
name = '{{ name }}',
description = '{{ description }}',
region = '{{ region }}',
ipCidrRange = '{{ ipCidrRange }}',
status = '{{ status }}',
parentPrefix = '{{ parentPrefix }}',
publicDelegatedSubPrefixs = '{{ publicDelegatedSubPrefixs }}',
isLiveMigration = true|false,
fingerprint = '{{ fingerprint }}',
mode = '{{ mode }}',
allocatablePrefixLength = '{{ allocatablePrefixLength }}',
byoipApiVersion = '{{ byoipApiVersion }}'
WHERE
project = '{{ project }}'
AND publicDelegatedPrefix = '{{ publicDelegatedPrefix }}';

DELETE example

Deletes the specified global_public_delegated_prefixes resource.

/*+ delete */
DELETE FROM google.compute.global_public_delegated_prefixes
WHERE project = '{{ project }}'
AND publicDelegatedPrefix = '{{ publicDelegatedPrefix }}';