Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class InternalRange.
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.
Generated from protobuf message google.cloud.networkconnectivity.v1.InternalRange
Namespace
Google \ Cloud \ NetworkConnectivity \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
↳ create_time
↳ update_time
↳ labels
↳ description
string
Optional. A description of this resource.
↳ 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.
↳ 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}
↳ usage
int
Optional. The type of usage set for this InternalRange.
↳ peering
int
Optional. The type of peering set for this internal range.
↳ prefix_length
int
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.
↳ target_cidr_range
array
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" address space. This can be used to 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.
↳ users
array
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.
↳ overlaps
array
Optional. Types of resources that are allowed to overlap with the current internal range.
↳ migration
↳ immutable
bool
Optional. Immutable ranges cannot have their fields modified, except for labels and description.
↳ allocation_options
InternalRange\AllocationOptions
Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length).
↳ exclude_cidr_ranges
array
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
getName
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
string
setName
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
var
string
$this
getCreateTime
Time when the internal range was created.
hasCreateTime
clearCreateTime
setCreateTime
Time when the internal range was created.
$this
getUpdateTime
Time when the internal range was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Time when the internal range was updated.
$this
getLabels
User-defined labels.
setLabels
User-defined labels.
$this
getDescription
Optional. A description of this resource.
string
setDescription
Optional. A description of this resource.
var
string
$this
getIpCidrRange
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.
string
setIpCidrRange
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.
var
string
$this
getNetwork
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}
string
setNetwork
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}
var
string
$this
getUsage
Optional. The type of usage set for this InternalRange.
int
setUsage
Optional. The type of usage set for this InternalRange.
var
int
$this
getPeering
Optional. The type of peering set for this internal range.
int
setPeering
Optional. The type of peering set for this internal range.
var
int
$this
getPrefixLength
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.
int
setPrefixLength
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.
var
int
$this
getTargetCidrRange
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" address space. This can be used to 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.
setTargetCidrRange
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" address space. This can be used to 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.
var
string[]
$this
getUsers
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.
setUsers
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.
var
string[]
$this
getOverlaps
Optional. Types of resources that are allowed to overlap with the current internal range.
setOverlaps
Optional. Types of resources that are allowed to overlap with the current internal range.
var
int[]
$this
getMigration
Optional. Must be present if usage is set to FOR_MIGRATION.
hasMigration
clearMigration
setMigration
Optional. Must be present if usage is set to FOR_MIGRATION.
$this
getImmutable
Optional. Immutable ranges cannot have their fields modified, except for labels and description.
bool
setImmutable
Optional. Immutable ranges cannot have their fields modified, except for labels and description.
var
bool
$this
getAllocationOptions
Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length).
hasAllocationOptions
clearAllocationOptions
setAllocationOptions
Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length).
$this
getExcludeCidrRanges
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
setExcludeCidrRanges
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
var
string[]
$this
