Compute V1 Client - Class PublicDelegatedPrefix (1.13.0)

Reference documentation and code samples for the Compute V1 Client class PublicDelegatedPrefix.

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.

Generated from protobuf message google.cloud.compute.v1.PublicDelegatedPrefix

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ byoip_api_version`	`string` [Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.
`↳ creation_timestamp`	`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` 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.
`↳ id`	`int\|string` [Output Only] The unique identifier for the resource type. The server generates this identifier.
`↳ ip_cidr_range`	`string` The IP address range, in CIDR format, represented by this public delegated prefix.
`↳ is_live_migration`	`bool` If true, the prefix will be live migrated.
`↳ kind`	`string` [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
`↳ 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.
`↳ parent_prefix`	`string` The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
`↳ public_delegated_sub_prefixs`	`array<Google\Cloud\Compute\V1\PublicDelegatedPrefixPublicDelegatedSubPrefix>` 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.
`↳ self_link`	`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. Check the Status enum for the list of possible values.

getByoipApiVersion

[Output Only] The version of BYOIP API.

Check the ByoipApiVersion enum for the list of possible values.

Returns
Type	Description
`string`

hasByoipApiVersion

clearByoipApiVersion

setByoipApiVersion

[Output Only] The version of BYOIP API.

Check the ByoipApiVersion enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasFingerprint

clearFingerprint

setFingerprint

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getId

[Output Only] The unique identifier for the resource type. The server generates this identifier.

Returns
Type	Description
`int\|string`

hasId

clearId

setId

[Output Only] The unique identifier for the resource type. The server generates this identifier.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getIpCidrRange

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

Returns
Type	Description
`string`

hasIpCidrRange

clearIpCidrRange

setIpCidrRange

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIsLiveMigration

If true, the prefix will be live migrated.

Returns
Type	Description
`bool`

hasIsLiveMigration

clearIsLiveMigration

setIsLiveMigration

If true, the prefix will be live migrated.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getKind

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

Returns
Type	Description
`string`

hasKind

clearKind

setKind

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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

Returns
Type	Description
`string`

hasName

clearName

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getParentPrefix

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

Returns
Type	Description
`string`

hasParentPrefix

clearParentPrefix

setParentPrefix

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPublicDelegatedSubPrefixs

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPublicDelegatedSubPrefixs

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

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\PublicDelegatedPrefixPublicDelegatedSubPrefix>`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasRegion

clearRegion

setRegion

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSelfLink

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

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasStatus

clearStatus

setStatus

Check the Status enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`