Class: Google::Apis::NetworkconnectivityV1::InternalRange

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

Overview

The internal range resource for IPAM operations within a VPC network. Used to represent a private address range along with behavioral characteristics of that range (its usage and peering behavior). Networking resources can link to this range if they are created as belonging to it.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InternalRange

Returns a new instance of InternalRange.



1544
1545
1546
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1544

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

Instance Attribute Details

#allocation_options ⇒ Google::Apis::NetworkconnectivityV1::AllocationOptions

Range auto-allocation options, to be optionally used when CIDR block is not explicitly set. Corresponds to the JSON property allocationOptions

Returns:



1432
1433
1434
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1432

def allocation_options
  @allocation_options
end

#create_time ⇒ String

Time when the internal range was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1437
1438
1439
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1437

def create_time
  @create_time
end

#description ⇒ String

Optional. A description of this resource. Corresponds to the JSON property description

Returns:

  • (String) 


1442
1443
1444
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1442

def description
  @description
end

#exclude_cidr_ranges ⇒ Array<String>

Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks Corresponds to the JSON property excludeCidrRanges

Returns:

  • (Array<String>) 


1449
1450
1451
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1449

def exclude_cidr_ranges
  @exclude_cidr_ranges
end

#immutable ⇒ Boolean Also known as: immutable?

Optional. Immutable ranges cannot have their fields modified, except for labels and description. Corresponds to the JSON property immutable

Returns:

  • (Boolean) 


1455
1456
1457
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1455

def immutable
  @immutable
end

#ip_cidr_range ⇒ String

Optional. The IP range that this internal range defines. NOTE: IPv6 ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For IPv6 Ranges this field is compulsory, i.e. the address range must be specified explicitly. Corresponds to the JSON property ipCidrRange

Returns:

  • (String) 


1463
1464
1465
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1463

def ip_cidr_range
  @ip_cidr_range
end

#labels ⇒ Hash<String,String>

User-defined labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1468
1469
1470
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1468

def labels
  @labels
end

#migration ⇒ Google::Apis::NetworkconnectivityV1::Migration

Specification for migration with source and target resource names. Corresponds to the JSON property migration

Returns:



1473
1474
1475
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1473

def migration
  @migration
end

#name ⇒ String

Identifier. The name of an internal range. Format: projects/project/ locations/location/internalRanges/internal_range See: https://google.aip. dev/122#fields-representing-resource-names Corresponds to the JSON property name

Returns:

  • (String) 


1480
1481
1482
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1480

def name
  @name
end

#network ⇒ String

Immutable. The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/`project`/locations/ global/networks/network projects/project/locations/global/networks/ network network Corresponds to the JSON property network

Returns:

  • (String) 


1490
1491
1492
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1490

def network
  @network
end

#overlaps ⇒ Array<String>

Optional. Types of resources that are allowed to overlap with the current internal range. Corresponds to the JSON property overlaps

Returns:

  • (Array<String>) 


1496
1497
1498
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1496

def overlaps
  @overlaps
end

#peering ⇒ String

Optional. The type of peering set for this internal range. Corresponds to the JSON property peering

Returns:

  • (String) 


1501
1502
1503
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1501

def peering
  @peering
end

#prefix_length ⇒ Fixnum

Optional. An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. Corresponds to the JSON property prefixLength

Returns:

  • (Fixnum) 


1512
1513
1514
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1512

def prefix_length
  @prefix_length
end

#target_cidr_range ⇒ Array<String>

Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the ["10.0.0.0/8", "172.16. 0.0/12", "192.168.0.0/16"] address space (for auto-mode networks, the "10.0.0. 0/9" range is used instead of "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/ 16" or non-rfc-1918 address spaces used in the VPC. Corresponds to the JSON property targetCidrRange

Returns:

  • (Array<String>) 


1522
1523
1524
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1522

def target_cidr_range
  @target_cidr_range
end

#update_time ⇒ String

Time when the internal range was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1527
1528
1529
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1527

def update_time
  @update_time
end

#usage ⇒ String

Optional. The type of usage set for this InternalRange. Corresponds to the JSON property usage

Returns:

  • (String) 


1532
1533
1534
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1532

def usage
  @usage
end

#users ⇒ Array<String>

Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty. Corresponds to the JSON property users

Returns:

  • (Array<String>) 


1542
1543
1544
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1542

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1549

def update!(**args)
  @allocation_options = args[:allocation_options] if args.key?(:allocation_options)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @exclude_cidr_ranges = args[:exclude_cidr_ranges] if args.key?(:exclude_cidr_ranges)
  @immutable = args[:immutable] if args.key?(:immutable)
  @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
  @labels = args[:labels] if args.key?(:labels)
  @migration = args[:migration] if args.key?(:migration)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @overlaps = args[:overlaps] if args.key?(:overlaps)
  @peering = args[:peering] if args.key?(:peering)
  @prefix_length = args[:prefix_length] if args.key?(:prefix_length)
  @target_cidr_range = args[:target_cidr_range] if args.key?(:target_cidr_range)
  @update_time = args[:update_time] if args.key?(:update_time)
  @usage = args[:usage] if args.key?(:usage)
  @users = args[:users] if args.key?(:users)
end