public_delegated_prefixes

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

Overview

Name	public_delegated_prefixes
Type	Resource
Id	google.compute.public_delegated_prefixes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource type. The server generates this identifier.
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. (pattern: a-z?)
allocatablePrefixLength	integer (int32)	The 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.
byoipApiVersion	string	[Output Only] The version of BYOIP API.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
fingerprint	string (byte)	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.
ipCidrRange	string	The IP address range, in CIDR format, represented by this public delegated prefix.
isLiveMigration	boolean	If true, the prefix will be live migrated.
kind	string	[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. (default: compute#publicDelegatedPrefix)
mode	string	The public delegated prefix mode for IPv6 only.
parentPrefix	string	The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
publicDelegatedSubPrefixs	array	The list of sub public delegated prefixes that exist for this public delegated prefix.
region	string	[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.
selfLink	string	[Output Only] Server-defined URL for the resource.
status	string	[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 announced and ready to use. - DELETING The public delegated prefix is being deprovsioned.

list

Successful response

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of PublicDelegatedPrefix resources.
kind	string	[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes. (default: compute#publicDelegatedPrefixList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	[Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, publicDelegatedPrefix		Returns the specified PublicDelegatedPrefix resource in the given region.
list	select	project, region	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Lists the PublicDelegatedPrefixes for a project in the given region.
insert	insert	project, region	requestId	Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.
patch	update	project, region, publicDelegatedPrefix	requestId	Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
delete	delete	project, region, publicDelegatedPrefix	requestId	Deletes the specified PublicDelegatedPrefix in the given region.
announce	exec	project, region, publicDelegatedPrefix	requestId	Announces the specified PublicDelegatedPrefix in the given region.
withdraw	exec	project, region, publicDelegatedPrefix	requestId	Withdraws the specified PublicDelegatedPrefix in the given region.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
project	string
publicDelegatedPrefix	string
region	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified PublicDelegatedPrefix resource in the given region.

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

list

Lists the PublicDelegatedPrefixes for a project in the given region.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.public_delegated_prefixes
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

insert

Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.

INSERT INTO google.compute.public_delegated_prefixes (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__selfLink,
data__region,
data__ipCidrRange,
data__status,
data__parentPrefix,
data__publicDelegatedSubPrefixs,
data__isLiveMigration,
data__fingerprint,
data__mode,
data__allocatablePrefixLength,
data__byoipApiVersion,
project,
region,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ selfLink }}',
'{{ region }}',
'{{ ipCidrRange }}',
'{{ status }}',
'{{ parentPrefix }}',
'{{ publicDelegatedSubPrefixs }}',
{{ isLiveMigration }},
'{{ fingerprint }}',
'{{ mode }}',
{{ allocatablePrefixLength }},
'{{ byoipApiVersion }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: public_delegated_prefixes
  props:
    - name: project
      value: string
      description: Required parameter for the public_delegated_prefixes resource.
    - name: region
      value: string
      description: Required parameter for the public_delegated_prefixes resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
        
      default: compute#publicDelegatedPrefix
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource type. The server generates this identifier.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: region
      value: string
      description: >
        [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.
        
    - name: ipCidrRange
      value: string
      description: >
        The IP address range, in CIDR format, represented by this public delegated prefix.
        
    - name: status
      value: string
      description: >
        [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 announced and ready to use. - `DELETING` The public delegated prefix is being deprovsioned. 
        
      valid_values: ['ANNOUNCED', 'ANNOUNCED_TO_GOOGLE', 'ANNOUNCED_TO_INTERNET', 'DELETING', 'INITIALIZING', 'READY_TO_ANNOUNCE']
    - name: parentPrefix
      value: string
      description: >
        The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
        
    - name: publicDelegatedSubPrefixs
      value: array
      description: >
        The list of sub public delegated prefixes that exist for this public delegated prefix.
        
    - name: isLiveMigration
      value: boolean
      description: >
        If true, the prefix will be live migrated.
        
    - name: fingerprint
      value: string
      description: >
        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.
        
    - name: mode
      value: string
      description: >
        The public delegated prefix mode for IPv6 only.
        
      valid_values: ['DELEGATION', 'EXTERNAL_IPV6_FORWARDING_RULE_CREATION', 'EXTERNAL_IPV6_SUBNETWORK_CREATION']
    - name: allocatablePrefixLength
      value: integer
      description: >
        The 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.
        
    - name: byoipApiVersion
      value: string
      description: >
        [Output Only] The version of BYOIP API.
        
      valid_values: ['V1', 'V2']
    - name: requestId
      value: string

UPDATE examples

patch

Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

UPDATE google.compute.public_delegated_prefixes
SET 
data__kind = '{{ kind }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__selfLink = '{{ selfLink }}',
data__region = '{{ region }}',
data__ipCidrRange = '{{ ipCidrRange }}',
data__status = '{{ status }}',
data__parentPrefix = '{{ parentPrefix }}',
data__publicDelegatedSubPrefixs = '{{ publicDelegatedSubPrefixs }}',
data__isLiveMigration = {{ isLiveMigration }},
data__fingerprint = '{{ fingerprint }}',
data__mode = '{{ mode }}',
data__allocatablePrefixLength = {{ allocatablePrefixLength }},
data__byoipApiVersion = '{{ byoipApiVersion }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND publicDelegatedPrefix = '{{ publicDelegatedPrefix }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples

delete

Deletes the specified PublicDelegatedPrefix in the given region.

DELETE FROM google.compute.public_delegated_prefixes
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND publicDelegatedPrefix = '{{ publicDelegatedPrefix }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods

announce

Announces the specified PublicDelegatedPrefix in the given region.

EXEC google.compute.public_delegated_prefixes.announce 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@publicDelegatedPrefix='{{ publicDelegatedPrefix }}' --required, 
@requestId='{{ requestId }}';

withdraw

Withdraws the specified PublicDelegatedPrefix in the given region.

EXEC google.compute.public_delegated_prefixes.withdraw 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@publicDelegatedPrefix='{{ publicDelegatedPrefix }}' --required, 
@requestId='{{ requestId }}';