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

Name	Datatype	Description
`id`	`string`	[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.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`allocatablePrefixLength`	`integer`	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.
`fingerprint`	`string`	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.
`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 active. - `DELETING` The public delegated prefix is being deprovsioned.

Methods

Name	Accessible by	Required Params	Description
`aggregated_list`	`SELECT`	`project`	Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`get`	`SELECT`	`project, publicDelegatedPrefix, region`	Returns the specified PublicDelegatedPrefix resource in the given region.
`list`	`SELECT`	`project, region`	Lists the PublicDelegatedPrefixes for a project in the given region.
`insert`	`INSERT`	`project, region`	Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.
`delete`	`DELETE`	`project, publicDelegatedPrefix, region`	Deletes the specified PublicDelegatedPrefix in the given region.
`patch`	`UPDATE`	`project, publicDelegatedPrefix, region`	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.
`announce`	`EXEC`	`project, publicDelegatedPrefix, region`	Announces the specified PublicDelegatedPrefix in the given region.
`withdraw`	`EXEC`	`project, publicDelegatedPrefix, region`	Withdraws the specified PublicDelegatedPrefix in the given region.

`SELECT` examples

Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

`INSERT` example

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

All Properties
Manifest

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

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: selfLink
      value: string
    - name: region
      value: string
    - name: ipCidrRange
      value: string
    - name: status
      value: string
    - name: parentPrefix
      value: string
    - name: publicDelegatedSubPrefixs
      value:
        - - name: name
            value: string
          - name: description
            value: string
          - name: region
            value: string
          - name: status
            value: string
          - name: ipCidrRange
            value: string
          - name: delegateeProject
            value: string
          - name: isAddress
            value: boolean
          - name: mode
            value: string
          - name: allocatablePrefixLength
            value: integer
    - name: isLiveMigration
      value: boolean
    - name: fingerprint
      value: string
    - name: mode
      value: string
    - name: allocatablePrefixLength
      value: integer
    - name: byoipApiVersion
      value: string

`UPDATE` example

Updates a public_delegated_prefixes resource.

/*+ update */
UPDATE google.compute.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 }}'
AND region = '{{ region }}';

`DELETE` example

Deletes the specified public_delegated_prefixes resource.

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

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​