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.



30190
30191
30192
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30190

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) 


30087
30088
30089
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30087

def allocatable_prefix_length
  @allocatable_prefix_length
end

#byoip_api_version ⇒ String

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

Returns:

  • (String) 


30092
30093
30094
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30092

def byoip_api_version
  @byoip_api_version
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


30097
30098
30099
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30097

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) 


30103
30104
30105
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30103

def description
  @description
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 the PublicDelegatedPrefix, 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) 


30114
30115
30116
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30114

def fingerprint
  @fingerprint
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


30120
30121
30122
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30120

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) 


30126
30127
30128
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30126

def ip_cidr_range
  @ip_cidr_range
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) 


30131
30132
30133
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30131

def is_live_migration
  @is_live_migration
end

#kind ⇒ String

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

Returns:

  • (String) 


30138
30139
30140
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30138

def kind
  @kind
end

#mode ⇒ String

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

Returns:

  • (String) 


30143
30144
30145
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30143

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

Returns:

  • (String) 


30153
30154
30155
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30153

def name
  @name
end

#parent_prefix ⇒ String

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

Returns:

  • (String) 


30159
30160
30161
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30159

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:



30165
30166
30167
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30165

def public_delegated_sub_prefixs
  @public_delegated_sub_prefixs
end

#region ⇒ String

[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) 


30173
30174
30175
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30173

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


30178
30179
30180
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30178

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 active. - DELETING The public delegated prefix is being deprovsioned. Corresponds to the JSON property status

Returns:

  • (String) 


30188
30189
30190
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30188

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30195
30196
30197
30198
30199
30200
30201
30202
30203
30204
30205
30206
30207
30208
30209
30210
30211
30212
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30195

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)
  @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)
  @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