Reference documentation and code samples for the Compute V1 Client class PublicAdvertisedPrefix.
A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.
Generated from protobuf message google.cloud.compute.v1.PublicAdvertisedPrefix
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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. |
↳ dns_verification_ip |
string
The IPv4 address to be used for reverse DNS verification. |
↳ 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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix. |
↳ 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 advertised prefix. |
↳ kind |
string
[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised 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 |
↳ public_delegated_prefixs |
array<Google\Cloud\Compute\V1\PublicAdvertisedPrefixPublicDelegatedPrefix>
[Output Only] The list of public delegated prefixes that exist for this public advertised prefix. |
↳ self_link |
string
[Output Only] Server-defined URL for the resource. |
↳ shared_secret |
string
[Output Only] The shared secret to be used for reverse DNS verification. |
↳ status |
string
The status of the public advertised prefix. Possible values include: - |
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
string | |
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
An optional description of this resource. Provide this property when you create the resource.
Generated from protobuf field optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDnsVerificationIp
The IPv4 address to be used for reverse DNS verification.
Generated from protobuf field optional string dns_verification_ip = 241011381;
| Returns | |
|---|---|
| Type | Description |
string | |
hasDnsVerificationIp
clearDnsVerificationIp
setDnsVerificationIp
The IPv4 address to be used for reverse DNS verification.
Generated from protobuf field optional string dns_verification_ip = 241011381;
| 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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
Generated from protobuf field optional string fingerprint = 234678500;
| Returns | |
|---|---|
| Type | Description |
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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
Generated from protobuf field optional string fingerprint = 234678500;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
[Output Only] The unique identifier for the resource type. The server generates this identifier.
Generated from protobuf field optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIpCidrRange
The IPv4 address range, in CIDR format, represented by this public advertised prefix.
Generated from protobuf field optional string ip_cidr_range = 98117322;
| Returns | |
|---|---|
| Type | Description |
string | |
hasIpCidrRange
clearIpCidrRange
setIpCidrRange
The IPv4 address range, in CIDR format, represented by this public advertised prefix.
Generated from protobuf field optional string ip_cidr_range = 98117322;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
Generated from protobuf field optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
Generated from protobuf field optional string kind = 3292052;
| 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.
Generated from protobuf field optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPublicDelegatedPrefixs
[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
Generated from protobuf field repeated .google.cloud.compute.v1.PublicAdvertisedPrefixPublicDelegatedPrefix public_delegated_prefixs = 425811723;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPublicDelegatedPrefixs
[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
Generated from protobuf field repeated .google.cloud.compute.v1.PublicAdvertisedPrefixPublicDelegatedPrefix public_delegated_prefixs = 425811723;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\PublicAdvertisedPrefixPublicDelegatedPrefix>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
string | |
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSharedSecret
[Output Only] The shared secret to be used for reverse DNS verification.
Generated from protobuf field optional string shared_secret = 381932490;
| Returns | |
|---|---|
| Type | Description |
string | |
hasSharedSecret
clearSharedSecret
setSharedSecret
[Output Only] The shared secret to be used for reverse DNS verification.
Generated from protobuf field optional string shared_secret = 381932490;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
The status of the public advertised prefix. Possible values include: - INITIAL: RPKI validation is complete. - PTR_CONFIGURED: User has configured the PTR. - VALIDATED: Reverse DNS lookup is successful. - REVERSE_DNS_LOOKUP_FAILED: Reverse DNS lookup failed. - PREFIX_CONFIGURATION_IN_PROGRESS: The prefix is being configured. - PREFIX_CONFIGURATION_COMPLETE: The prefix is fully configured. - PREFIX_REMOVAL_IN_PROGRESS: The prefix is being removed.
Check the Status enum for the list of possible values.
Generated from protobuf field optional string status = 181260274;
| Returns | |
|---|---|
| Type | Description |
string | |
hasStatus
clearStatus
setStatus
The status of the public advertised prefix. Possible values include: - INITIAL: RPKI validation is complete. - PTR_CONFIGURED: User has configured the PTR. - VALIDATED: Reverse DNS lookup is successful. - REVERSE_DNS_LOOKUP_FAILED: Reverse DNS lookup failed. - PREFIX_CONFIGURATION_IN_PROGRESS: The prefix is being configured. - PREFIX_CONFIGURATION_COMPLETE: The prefix is fully configured. - PREFIX_REMOVAL_IN_PROGRESS: The prefix is being removed.
Check the Status enum for the list of possible values.
Generated from protobuf field optional string status = 181260274;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |