Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::PublicAdvertisedPrefix (v2.11.0)

Version 2.11.0

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.5.0

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#byoip_api_version

def byoip_api_version() -> ::String

Returns

• (::String) — [Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.

#byoip_api_version=

def byoip_api_version=(value) -> ::String

Parameter

• value (::String) — [Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.

Returns

• (::String) — [Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.

#creation_timestamp

def creation_timestamp() -> ::String

Returns

• (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String

Parameter

• value (::String) — [Output Only] Creation timestamp in RFC3339 text format.

Returns

• (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#description

def description() -> ::String

Returns

• (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — An optional description of this resource. Provide this property when you create the resource.

Returns

• (::String) — An optional description of this resource. Provide this property when you create the resource.

#dns_verification_ip

def dns_verification_ip() -> ::String

Returns

• (::String) — The address to be used for reverse DNS verification.

#dns_verification_ip=

def dns_verification_ip=(value) -> ::String

Parameter

• value (::String) — The address to be used for reverse DNS verification.

Returns

• (::String) — The address to be used for reverse DNS verification.

#fingerprint

def fingerprint() -> ::String

Returns

• (::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.

#fingerprint=

def fingerprint=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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

def id() -> ::Integer

Returns

• (::Integer) — [Output Only] The unique identifier for the resource type. The server generates this identifier.

#id=

def id=(value) -> ::Integer

Parameter

• value (::Integer) — [Output Only] The unique identifier for the resource type. The server generates this identifier.

Returns

• (::Integer) — [Output Only] The unique identifier for the resource type. The server generates this identifier.

#ip_cidr_range

def ip_cidr_range() -> ::String

Returns

• (::String) — The address range, in CIDR format, represented by this public advertised prefix.

#ip_cidr_range=

def ip_cidr_range=(value) -> ::String

Parameter

• value (::String) — The address range, in CIDR format, represented by this public advertised prefix.

Returns

• (::String) — The address range, in CIDR format, represented by this public advertised prefix.

#kind

def kind() -> ::String

Returns

• (::String) — [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

#kind=

def kind=(value) -> ::String

Parameter

• value (::String) — [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

Returns

• (::String) — [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

#name

def name() -> ::String

Returns

• (::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.

#name=

def name=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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

def pdp_scope() -> ::String

Returns

• (::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.

#pdp_scope=

def pdp_scope=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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

def public_delegated_prefixs() -> ::Array<::Google::Cloud::Compute::V1::PublicAdvertisedPrefixPublicDelegatedPrefix>

Returns

• (::Array<::Google::Cloud::Compute::V1::PublicAdvertisedPrefixPublicDelegatedPrefix>) — [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

#public_delegated_prefixs=

def public_delegated_prefixs=(value) -> ::Array<::Google::Cloud::Compute::V1::PublicAdvertisedPrefixPublicDelegatedPrefix>

Parameter

• value (::Array<::Google::Cloud::Compute::V1::PublicAdvertisedPrefixPublicDelegatedPrefix>) — [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

Returns

• (::Array<::Google::Cloud::Compute::V1::PublicAdvertisedPrefixPublicDelegatedPrefix>) — [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

#self_link

def self_link() -> ::String

Returns

• (::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String

Parameter

• value (::String) — [Output Only] Server-defined URL for the resource.

Returns

• (::String) — [Output Only] Server-defined URL for the resource.

#shared_secret

def shared_secret() -> ::String

Returns

• (::String) — [Output Only] The shared secret to be used for reverse DNS verification.

#shared_secret=

def shared_secret=(value) -> ::String

Parameter

• value (::String) — [Output Only] The shared secret to be used for reverse DNS verification.

Returns

• (::String) — [Output Only] The shared secret to be used for reverse DNS verification.

#status

def status() -> ::String

Returns

• (::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.

#status=

def status=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.