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.



30325
30326
30327
# File 'lib/google/apis/compute_v1/classes.rb', line 30325

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

Instance Attribute Details

#allocatable_prefix_lengthFixnum

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)


30222
30223
30224
# File 'lib/google/apis/compute_v1/classes.rb', line 30222

def allocatable_prefix_length
  @allocatable_prefix_length
end

#byoip_api_versionString

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

Returns:

  • (String)


30227
30228
30229
# File 'lib/google/apis/compute_v1/classes.rb', line 30227

def byoip_api_version
  @byoip_api_version
end

#creation_timestampString

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

Returns:

  • (String)


30232
30233
30234
# File 'lib/google/apis/compute_v1/classes.rb', line 30232

def creation_timestamp
  @creation_timestamp
end

#descriptionString

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

Returns:

  • (String)


30238
30239
30240
# File 'lib/google/apis/compute_v1/classes.rb', line 30238

def description
  @description
end

#fingerprintString

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)


30249
30250
30251
# File 'lib/google/apis/compute_v1/classes.rb', line 30249

def fingerprint
  @fingerprint
end

#idFixnum

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

Returns:

  • (Fixnum)


30255
30256
30257
# File 'lib/google/apis/compute_v1/classes.rb', line 30255

def id
  @id
end

#ip_cidr_rangeString

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

Returns:

  • (String)


30261
30262
30263
# File 'lib/google/apis/compute_v1/classes.rb', line 30261

def ip_cidr_range
  @ip_cidr_range
end

#is_live_migrationBoolean Also known as: is_live_migration?

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

Returns:

  • (Boolean)


30266
30267
30268
# File 'lib/google/apis/compute_v1/classes.rb', line 30266

def is_live_migration
  @is_live_migration
end

#kindString

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

Returns:

  • (String)


30273
30274
30275
# File 'lib/google/apis/compute_v1/classes.rb', line 30273

def kind
  @kind
end

#modeString

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

Returns:

  • (String)


30278
30279
30280
# File 'lib/google/apis/compute_v1/classes.rb', line 30278

def mode
  @mode
end

#nameString

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)


30288
30289
30290
# File 'lib/google/apis/compute_v1/classes.rb', line 30288

def name
  @name
end

#parent_prefixString

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

Returns:

  • (String)


30294
30295
30296
# File 'lib/google/apis/compute_v1/classes.rb', line 30294

def parent_prefix
  @parent_prefix
end

#public_delegated_sub_prefixsArray<Google::Apis::ComputeV1::PublicDelegatedPrefixPublicDelegatedSubPrefix>

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



30300
30301
30302
# File 'lib/google/apis/compute_v1/classes.rb', line 30300

def public_delegated_sub_prefixs
  @public_delegated_sub_prefixs
end

#regionString

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


30308
30309
30310
# File 'lib/google/apis/compute_v1/classes.rb', line 30308

def region
  @region
end

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

Returns:

  • (String)


30313
30314
30315
# File 'lib/google/apis/compute_v1/classes.rb', line 30313

def self_link
  @self_link
end

#statusString

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


30323
30324
30325
# File 'lib/google/apis/compute_v1/classes.rb', line 30323

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30330
30331
30332
30333
30334
30335
30336
30337
30338
30339
30340
30341
30342
30343
30344
30345
30346
30347
# File 'lib/google/apis/compute_v1/classes.rb', line 30330

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