Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::PublicAdvertisedPrefix (v3.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. [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. [Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.
Returns
  • (::String) — Output only. [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. [Output Only] Creation timestamp inRFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
Returns
  • (::String) — Output only. [Output Only] Creation timestamp inRFC3339 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 thePublicAdvertisedPrefix, 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 thePublicAdvertisedPrefix, 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 thePublicAdvertisedPrefix, 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. [Output Only] The unique identifier for the resource type. The server generates this identifier.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.
Returns
  • (::Integer) — Output only. [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.

#ipv6_access_type

def ipv6_access_type() -> ::String
Returns
  • (::String) — The internet access type for IPv6 Public Advertised Prefixes. Check the Ipv6AccessType enum for the list of possible values.

#ipv6_access_type=

def ipv6_access_type=(value) -> ::String
Parameter
  • value (::String) — The internet access type for IPv6 Public Advertised Prefixes. Check the Ipv6AccessType enum for the list of possible values.
Returns
  • (::String) — The internet access type for IPv6 Public Advertised Prefixes. Check the Ipv6AccessType enum for the list of possible values.

#kind

def kind() -> ::String
Returns
  • (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.
Returns
  • (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#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 withRFC1035. 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 withRFC1035. 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 withRFC1035. 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

#public_delegated_prefixs=

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

#self_link

def self_link() -> ::String
Returns
  • (::String) — Output only. [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — Output only. [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.