Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::PublicDelegatedPrefix (v3.5.0)

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#allocatable_prefix_length

def allocatable_prefix_length() -> ::Integer

Returns

(::Integer) — The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.

#allocatable_prefix_length=

def allocatable_prefix_length=(value) -> ::Integer

Parameter

value (::Integer) — The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.

Returns

(::Integer) — The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.

#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.

#enable_enhanced_ipv4_allocation

def enable_enhanced_ipv4_allocation() -> ::Boolean

Returns

(::Boolean) — Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.

#enable_enhanced_ipv4_allocation=

def enable_enhanced_ipv4_allocation=(value) -> ::Boolean

Parameter

value (::Boolean) — Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.

Returns

(::Boolean) — Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.

#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 PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update thePublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.

#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 PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update thePublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.

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 PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update thePublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.

#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 IP address range, in CIDR format, represented by this public delegated prefix.

#ip_cidr_range=

def ip_cidr_range=(value) -> ::String

Parameter

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

Returns

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

#ipv6_access_type

def ipv6_access_type() -> ::String

Returns

(::String) — Output only. [Output Only] The internet access type for IPv6 Public Delegated Prefixes. Inherited from parent prefix. Check the Ipv6AccessType enum for the list of possible values.

#ipv6_access_type=

def ipv6_access_type=(value) -> ::String

Parameter

value (::String) — Output only. [Output Only] The internet access type for IPv6 Public Delegated Prefixes. Inherited from parent prefix. Check the Ipv6AccessType enum for the list of possible values.

Returns

(::String) — Output only. [Output Only] The internet access type for IPv6 Public Delegated Prefixes. Inherited from parent prefix. Check the Ipv6AccessType enum for the list of possible values.

#is_live_migration

def is_live_migration() -> ::Boolean

Returns

(::Boolean) — If true, the prefix will be live migrated.

#is_live_migration=

def is_live_migration=(value) -> ::Boolean

Parameter

value (::Boolean) — If true, the prefix will be live migrated.

Returns

(::Boolean) — If true, the prefix will be live migrated.

#kind

def kind() -> ::String

Returns

(::String) — Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefix for public delegated prefixes.

#kind=

def kind=(value) -> ::String

Parameter

value (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefix for public delegated prefixes.

Returns

(::String) — Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefix for public delegated prefixes.

#mode

def mode() -> ::String

Returns

(::String) — The public delegated prefix mode for IPv6 only. Check the Mode enum for the list of possible values.

#mode=

def mode=(value) -> ::String

Parameter

value (::String) — The public delegated prefix mode for IPv6 only. Check the Mode enum for the list of possible values.

Returns

(::String) — The public delegated prefix mode for IPv6 only. Check the Mode enum for the list of possible values.

#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.

#parent_prefix

def parent_prefix() -> ::String

Returns

(::String) — The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

#parent_prefix=

def parent_prefix=(value) -> ::String

Parameter

value (::String) — The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

Returns

(::String) — The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

#public_delegated_sub_prefixs

def public_delegated_sub_prefixs() -> ::Array<::Google::Cloud::Compute::V1::PublicDelegatedPrefixPublicDelegatedSubPrefix>

Returns

(::Array<::Google::Cloud::Compute::V1::PublicDelegatedPrefixPublicDelegatedSubPrefix>) — The list of sub public delegated prefixes that exist for this public delegated prefix.

#public_delegated_sub_prefixs=

def public_delegated_sub_prefixs=(value) -> ::Array<::Google::Cloud::Compute::V1::PublicDelegatedPrefixPublicDelegatedSubPrefix>

Parameter

value (::Array<::Google::Cloud::Compute::V1::PublicDelegatedPrefixPublicDelegatedSubPrefix>) — The list of sub public delegated prefixes that exist for this public delegated prefix.

Returns

(::Array<::Google::Cloud::Compute::V1::PublicDelegatedPrefixPublicDelegatedSubPrefix>) — The list of sub public delegated prefixes that exist for this public delegated prefix.

#region

def region() -> ::String

Returns

(::String) — Output only. [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.

#region=

def region=(value) -> ::String

Parameter

value (::String) — Output only. [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.

Returns

(::String) — Output only. [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

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.

#status

def status() -> ::String

Returns

(::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 announced and ready to
 use.
 - `DELETING` The public delegated prefix is being deprovsioned.
 - `ACTIVE` The public delegated prefix is ready to use.

Check the Status enum for the list of possible values.

#status=

def status=(value) -> ::String

Parameter

value (::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 announced and ready to
 use.
 - `DELETING` The public delegated prefix is being deprovsioned.
 - `ACTIVE` The public delegated prefix is ready to use.

Check the Status enum for the list of possible values.

Returns

(::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 announced and ready to
 use.
 - `DELETING` The public delegated prefix is being deprovsioned.
 - `ACTIVE` The public delegated prefix is ready to use.

Check the Status enum for the list of possible values.