Console
    Start free

    Compute V1 Client - Class PublicDelegatedPrefix (2.10.0)

    Reference documentation and code samples for the Compute V1 Client class 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.

    Generated from protobuf message google.cloud.compute.v1.PublicDelegatedPrefix

    Namespace

    Google \ Cloud \ Compute \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ allocatable_prefix_length
    int

    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
    string

    Output only. [Output Only] The version of BYOIP API. Check the ByoipApiVersion enum for the list of possible values.

    ↳ creation_timestamp
    string

    Output only. [Output Only] Creation timestamp inRFC3339 text format.

    ↳ description
    string

    An optional description of this resource. Provide this property when you create the resource.

    ↳ enable_enhanced_ipv4_allocation
    bool

    Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.

    ↳ 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 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
    int|string

    Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.

    ↳ ip_cidr_range
    string

    The IP address range, in CIDR format, represented by this public delegated prefix.

    ↳ ipv6_access_type
    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
    bool

    If true, the prefix will be live migrated.

    ↳ kind
    string

    Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefix for public delegated prefixes.

    ↳ mode
    string

    The public delegated prefix mode for IPv6 only. Check the Mode enum for the list of possible values.

    ↳ 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 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
    string

    The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

    ↳ public_delegated_sub_prefixs
    array< PublicDelegatedPrefixPublicDelegatedSubPrefix >

    The list of sub public delegated prefixes that exist for this public delegated prefix.

    ↳ region
    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
    string

    Output only. [Output Only] Server-defined URL for the resource.

    ↳ status
    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.

    getAllocatablePrefixLength

    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
    Type
    Description
    int

    hasAllocatablePrefixLength

    clearAllocatablePrefixLength

    setAllocatablePrefixLength

    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.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getByoipApiVersion

    Output only. [Output Only] The version of BYOIP API.

    Check the ByoipApiVersion enum for the list of possible values.

    Returns
    Type
    Description
    string

    hasByoipApiVersion

    clearByoipApiVersion

    setByoipApiVersion

    Output only. [Output Only] The version of BYOIP API.

    Check the ByoipApiVersion enum for the list of possible values.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreationTimestamp

    Output only. [Output Only] Creation timestamp inRFC3339 text format.

    Returns
    Type
    Description
    string

    hasCreationTimestamp

    clearCreationTimestamp

    setCreationTimestamp

    Output only. [Output Only] Creation timestamp inRFC3339 text format.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    An optional description of this resource. Provide this property when you create the resource.

    Returns
    Type
    Description
    string

    hasDescription

    clearDescription

    setDescription

    An optional description of this resource. Provide this property when you create the resource.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getEnableEnhancedIpv4Allocation

    Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations.

    Applicable for IPv4 PDPs only.

    Returns
    Type
    Description
    bool

    hasEnableEnhancedIpv4Allocation

    clearEnableEnhancedIpv4Allocation

    setEnableEnhancedIpv4Allocation

    Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations.

    Applicable for IPv4 PDPs only.

    Parameter
    Name
    Description
    var
    bool
    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 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
    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 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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getId

    Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.

    Returns
    Type
    Description
    int|string

    hasId

    clearId

    setId

    Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this

    getIpCidrRange

    The IP address range, in CIDR format, represented by this public delegated prefix.

    Returns
    Type
    Description
    string

    hasIpCidrRange

    clearIpCidrRange

    setIpCidrRange

    The IP address range, in CIDR format, represented by this public delegated prefix.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getIpv6AccessType

    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
    Type
    Description
    string

    hasIpv6AccessType

    clearIpv6AccessType

    setIpv6AccessType

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getIsLiveMigration

    If true, the prefix will be live migrated.

    Returns
    Type
    Description
    bool

    hasIsLiveMigration

    clearIsLiveMigration

    setIsLiveMigration

    If true, the prefix will be live migrated.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getKind

    Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefix for public delegated prefixes.

    Returns
    Type
    Description
    string

    hasKind

    clearKind

    setKind

    Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefix for public delegated prefixes.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getMode

    The public delegated prefix mode for IPv6 only.

    Check the Mode enum for the list of possible values.

    Returns
    Type
    Description
    string

    hasMode

    clearMode

    setMode

    The public delegated prefix mode for IPv6 only.

    Check the Mode enum for the list of possible values.

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getParentPrefix

    The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

    Returns
    Type
    Description
    string

    hasParentPrefix

    clearParentPrefix

    setParentPrefix

    The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPublicDelegatedSubPrefixs

    The list of sub public delegated prefixes that exist for this public delegated prefix.

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < PublicDelegatedPrefixPublicDelegatedSubPrefix >

    setPublicDelegatedSubPrefixs

    The list of sub public delegated prefixes that exist for this public delegated prefix.

    Parameter
    Name
    Description
    var
    array< PublicDelegatedPrefixPublicDelegatedSubPrefix >
    Returns
    Type
    Description
    $this

    getRegion

    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
    Type
    Description
    string

    hasRegion

    clearRegion

    setRegion

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSelfLink

    Output only. [Output Only] Server-defined URL for the resource.

    Returns
    Type
    Description
    string

    hasSelfLink

    clearSelfLink

    setSelfLink

    Output only. [Output Only] Server-defined URL for the resource.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getStatus

    [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
    Type
    Description
    string

    hasStatus

    clearStatus

    setStatus

    [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.
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: