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
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
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.
↳ dns_verification_ip
string
The 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 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 [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.
↳ pdp_scope
string
Specifies how child public delegated prefix will be scoped. It could be one of following values: - REGIONAL
: The public delegated prefix is regional only. The provisioning will take a few minutes. - GLOBAL
: The public delegated prefix is global only. The provisioning will take ~4 weeks. - GLOBAL_AND_REGIONAL
[output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2. Check the PdpScope enum for the list of possible values.
↳ 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: - 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.
getByoipApiVersion
[Output Only] The version of BYOIP API.
Check the ByoipApiVersion enum for the list of possible values.
string
hasByoipApiVersion
clearByoipApiVersion
setByoipApiVersion
[Output Only] The version of BYOIP API.
Check the ByoipApiVersion enum for the list of possible values.
var
string
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$this
getDnsVerificationIp
The address to be used for reverse DNS verification.
string
hasDnsVerificationIp
clearDnsVerificationIp
setDnsVerificationIp
The address to be used for reverse DNS verification.
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 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.
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.
var
string
$this
getId
[Output Only] The unique identifier for the resource type. The server generates this identifier.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource type. The server generates this identifier.
var
int|string
$this
getIpCidrRange
The address range, in CIDR format, represented by this public advertised prefix.
string
hasIpCidrRange
clearIpCidrRange
setIpCidrRange
The address range, in CIDR format, represented by this public advertised prefix.
var
string
$this
getKind
[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
string
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
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.
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.
var
string
$this
getPdpScope
Specifies how child public delegated prefix will be scoped. It could be one of following values: - REGIONAL
: The public delegated prefix is regional only. The provisioning will take a few minutes. - GLOBAL
: The public delegated prefix is global only. The provisioning will take ~4 weeks. - GLOBAL_AND_REGIONAL
[output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2.
Check the PdpScope enum for the list of possible values.
string
hasPdpScope
clearPdpScope
setPdpScope
Specifies how child public delegated prefix will be scoped. It could be one of following values: - REGIONAL
: The public delegated prefix is regional only. The provisioning will take a few minutes. - GLOBAL
: The public delegated prefix is global only. The provisioning will take ~4 weeks. - GLOBAL_AND_REGIONAL
[output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2.
Check the PdpScope enum for the list of possible values.
var
string
$this
getPublicDelegatedPrefixs
[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
setPublicDelegatedPrefixs
[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
var
string
$this
getSharedSecret
[Output Only] The shared secret to be used for reverse DNS verification.
string
hasSharedSecret
clearSharedSecret
setSharedSecret
[Output Only] The shared secret to be used for reverse DNS verification.
var
string
$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.
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.
var
string
$this
