Class: Google::Apis::ComputeV1::PublicDelegatedPrefix

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PublicDelegatedPrefix

Returns a new instance of PublicDelegatedPrefix.



44954
44955
44956
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44954

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allocatable_prefix_length ⇒ Fixnum

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. Corresponds to the JSON property allocatablePrefixLength

Returns:

  • (Fixnum) 


44825
44826
44827
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44825

def allocatable_prefix_length
  @allocatable_prefix_length
end

#byoip_api_version ⇒ String

Output only. [Output Only] The version of BYOIP API. Corresponds to the JSON property byoipApiVersion

Returns:

  • (String) 


44830
44831
44832
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44830

def byoip_api_version
  @byoip_api_version
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


44836
44837
44838
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44836

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

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

Returns:

  • (String) 


44842
44843
44844
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44842

def description
  @description
end

#enable_enhanced_ipv4_allocation ⇒ Boolean Also known as: enable_enhanced_ipv4_allocation?

Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. Corresponds to the JSON property enableEnhancedIpv4Allocation

Returns:

  • (Boolean) 


44848
44849
44850
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44848

def enable_enhanced_ipv4_allocation
  @enable_enhanced_ipv4_allocation
end

#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. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


44862
44863
44864
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44862

def fingerprint
  @fingerprint
end

#id ⇒ Fixnum

Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


44869
44870
44871
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44869

def id
  @id
end

#ip_cidr_range ⇒ String

The IP address range, in CIDR format, represented by this public delegated prefix. Corresponds to the JSON property ipCidrRange

Returns:

  • (String) 


44875
44876
44877
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44875

def ip_cidr_range
  @ip_cidr_range
end

#ipv6_access_type ⇒ String

Output only. [Output Only] The internet access type for IPv6 Public Delegated Prefixes. Inherited from parent prefix. Corresponds to the JSON property ipv6AccessType

Returns:

  • (String) 


44882
44883
44884
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44882

def ipv6_access_type
  @ipv6_access_type
end

#is_live_migration ⇒ Boolean Also known as: is_live_migration?

If true, the prefix will be live migrated. Corresponds to the JSON property isLiveMigration

Returns:

  • (Boolean) 


44887
44888
44889
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44887

def is_live_migration
  @is_live_migration
end

#kind ⇒ String

Output only. [Output Only] Type of the resource. Alwayscompute# publicDelegatedPrefix for public delegated prefixes. Corresponds to the JSON property kind

Returns:

  • (String) 


44894
44895
44896
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44894

def kind
  @kind
end

#mode ⇒ String

The public delegated prefix mode for IPv6 only. Corresponds to the JSON property mode

Returns:

  • (String) 


44899
44900
44901
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44899

def mode
  @mode
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


44910
44911
44912
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44910

def name
  @name
end

#parent_prefix ⇒ String

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. Corresponds to the JSON property parentPrefix

Returns:

  • (String) 


44916
44917
44918
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44916

def parent_prefix
  @parent_prefix
end

#public_delegated_sub_prefixs ⇒ Array<Google::Apis::ComputeV1::PublicDelegatedPrefixPublicDelegatedSubPrefix>

The list of sub public delegated prefixes that exist for this public delegated prefix. Corresponds to the JSON property publicDelegatedSubPrefixs

Returns:



44922
44923
44924
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44922

def public_delegated_sub_prefixs
  @public_delegated_sub_prefixs
end

#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. Corresponds to the JSON property region

Returns:

  • (String) 


44931
44932
44933
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44931

def region
  @region
end

#self_link ⇒ String

Output only. [Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


44936
44937
44938
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44936

def self_link
  @self_link
end

#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. Corresponds to the JSON property status

Returns:

  • (String) 


44952
44953
44954
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44952

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



44959
44960
44961
44962
44963
44964
44965
44966
44967
44968
44969
44970
44971
44972
44973
44974
44975
44976
44977
44978
 
# File 'lib/google/apis/compute_v1/classes.rb', line 44959

def update!(**args)
  @allocatable_prefix_length = args[:allocatable_prefix_length] if args.key?(:allocatable_prefix_length)
  @byoip_api_version = args[:byoip_api_version] if args.key?(:byoip_api_version)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @enable_enhanced_ipv4_allocation = args[:enable_enhanced_ipv4_allocation] if args.key?(:enable_enhanced_ipv4_allocation)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @id = args[:id] if args.key?(:id)
  @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
  @ipv6_access_type = args[:ipv6_access_type] if args.key?(:ipv6_access_type)
  @is_live_migration = args[:is_live_migration] if args.key?(:is_live_migration)
  @kind = args[:kind] if args.key?(:kind)
  @mode = args[:mode] if args.key?(:mode)
  @name = args[:name] if args.key?(:name)
  @parent_prefix = args[:parent_prefix] if args.key?(:parent_prefix)
  @public_delegated_sub_prefixs = args[:public_delegated_sub_prefixs] if args.key?(:public_delegated_sub_prefixs)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @status = args[:status] if args.key?(:status)
end