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
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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 IPv4 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.
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
Generated from protobuf field optional string description = 422937596;
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
Generated from protobuf field optional string description = 422937596;
var
string
$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.
Generated from protobuf field optional string fingerprint = 234678500;
string
hasFingerprint
clearFingerprint
setFingerprint
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.
Generated from protobuf field optional string fingerprint = 234678500;
var
string
$this
getId
[Output Only] The unique identifier for the resource type. The server generates this identifier.
Generated from protobuf field optional uint64 id = 3355;
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource type. The server generates this identifier.
Generated from protobuf field optional uint64 id = 3355;
var
int|string
$this
getIpCidrRange
The IPv4 address range, in CIDR format, represented by this public delegated prefix.
Generated from protobuf field optional string ip_cidr_range = 98117322;
string
hasIpCidrRange
clearIpCidrRange
setIpCidrRange
The IPv4 address range, in CIDR format, represented by this public delegated prefix.
Generated from protobuf field optional string ip_cidr_range = 98117322;
var
string
$this
getIsLiveMigration
If true, the prefix will be live migrated.
Generated from protobuf field optional bool is_live_migration = 511823856;
bool
hasIsLiveMigration
clearIsLiveMigration
setIsLiveMigration
If true, the prefix will be live migrated.
Generated from protobuf field optional bool is_live_migration = 511823856;
var
bool
$this
getKind
[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
Generated from protobuf field optional string kind = 3292052;
string
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
Generated from protobuf field optional string kind = 3292052;
var
string
$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.
Generated from protobuf field optional string name = 3373707;
string
hasName
clearName
setName
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.
Generated from protobuf field optional string name = 3373707;
var
string
$this
getParentPrefix
The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
Generated from protobuf field optional string parent_prefix = 15233991;
string
hasParentPrefix
clearParentPrefix
setParentPrefix
The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
Generated from protobuf field optional string parent_prefix = 15233991;
var
string
$this
getPublicDelegatedSubPrefixs
The list of sub public delegated prefixes that exist for this public delegated prefix.
Generated from protobuf field repeated .google.cloud.compute.v1.PublicDelegatedPrefixPublicDelegatedSubPrefix public_delegated_sub_prefixs = 188940044;
Google\Protobuf\Internal\RepeatedField
setPublicDelegatedSubPrefixs
The list of sub public delegated prefixes that exist for this public delegated prefix.
Generated from protobuf field repeated .google.cloud.compute.v1.PublicDelegatedPrefixPublicDelegatedSubPrefix public_delegated_sub_prefixs = 188940044;
$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.
Generated from protobuf field optional string region = 138946292;
string
hasRegion
clearRegion
setRegion
[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.
Generated from protobuf field optional string region = 138946292;
var
string
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
var
string
$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.
Generated from protobuf field optional string status = 181260274;
string
hasStatus
clearStatus
setStatus
[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.
Generated from protobuf field optional string status = 181260274;
var
string
$this
