Reference documentation and code samples for the Network Connectivity V1 API class Google::Cloud::NetworkConnectivity::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allocation_options
def allocation_options() -> ::Google::Cloud::NetworkConnectivity::V1::InternalRange::AllocationOptions
Returns
- (::Google::Cloud::NetworkConnectivity::V1::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).
#allocation_options=
def allocation_options=(value) -> ::Google::Cloud::NetworkConnectivity::V1::InternalRange::AllocationOptions
Parameter
- value (::Google::Cloud::NetworkConnectivity::V1::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).
Returns
- (::Google::Cloud::NetworkConnectivity::V1::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).
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time when the internal range was created.
#create_time=
def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time when the internal range was created.
Returns
- (::Google::Protobuf::Timestamp) — Time when the internal range was created.
#description
def description() -> ::String
Returns
- (::String) — Optional. A description of this resource.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. A description of this resource.
Returns
- (::String) — Optional. A description of this resource.
#exclude_cidr_ranges
def exclude_cidr_ranges() -> ::Array<::String>
Returns
- (::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
#exclude_cidr_ranges=
def exclude_cidr_ranges=(value) -> ::Array<::String>
Parameter
- value (::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
Returns
- (::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
#immutable
def immutable() -> ::Boolean
Returns
- (::Boolean) — Optional. Immutable ranges cannot have their fields modified, except for labels and description.
#immutable=
def immutable=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Immutable ranges cannot have their fields modified, except for labels and description.
Returns
- (::Boolean) — Optional. Immutable ranges cannot have their fields modified, except for labels and description.
#ip_cidr_range
def ip_cidr_range() -> ::String
Returns
- (::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.
#ip_cidr_range=
def ip_cidr_range=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — User-defined labels.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — User-defined labels.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — User-defined labels.
#migration
def migration() -> ::Google::Cloud::NetworkConnectivity::V1::InternalRange::Migration
Returns
- (::Google::Cloud::NetworkConnectivity::V1::InternalRange::Migration) — Optional. Must be present if usage is set to FOR_MIGRATION.
#migration=
def migration=(value) -> ::Google::Cloud::NetworkConnectivity::V1::InternalRange::Migration
Parameter
- value (::Google::Cloud::NetworkConnectivity::V1::InternalRange::Migration) — Optional. Must be present if usage is set to FOR_MIGRATION.
Returns
- (::Google::Cloud::NetworkConnectivity::V1::InternalRange::Migration) — Optional. Must be present if usage is set to FOR_MIGRATION.
#name
def name() -> ::String
Returns
- (::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
#name=
def name=(value) -> ::String
Parameter
- value (::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
Returns
- (::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
#network
def network() -> ::String
Returns
- (::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}
#network=
def network=(value) -> ::String
Parameter
- value (::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}
Returns
- (::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}
#overlaps
def overlaps() -> ::Array<::Google::Cloud::NetworkConnectivity::V1::InternalRange::Overlap>
Returns
- (::Array<::Google::Cloud::NetworkConnectivity::V1::InternalRange::Overlap>) — Optional. Types of resources that are allowed to overlap with the current internal range.
#overlaps=
def overlaps=(value) -> ::Array<::Google::Cloud::NetworkConnectivity::V1::InternalRange::Overlap>
Parameter
- value (::Array<::Google::Cloud::NetworkConnectivity::V1::InternalRange::Overlap>) — Optional. Types of resources that are allowed to overlap with the current internal range.
Returns
- (::Array<::Google::Cloud::NetworkConnectivity::V1::InternalRange::Overlap>) — Optional. Types of resources that are allowed to overlap with the current internal range.
#peering
def peering() -> ::Google::Cloud::NetworkConnectivity::V1::InternalRange::Peering
Returns
- (::Google::Cloud::NetworkConnectivity::V1::InternalRange::Peering) — Optional. The type of peering set for this internal range.
#peering=
def peering=(value) -> ::Google::Cloud::NetworkConnectivity::V1::InternalRange::Peering
Parameter
- value (::Google::Cloud::NetworkConnectivity::V1::InternalRange::Peering) — Optional. The type of peering set for this internal range.
Returns
- (::Google::Cloud::NetworkConnectivity::V1::InternalRange::Peering) — Optional. The type of peering set for this internal range.
#prefix_length
def prefix_length() -> ::Integer
Returns
- (::Integer) — 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.
#prefix_length=
def prefix_length=(value) -> ::Integer
Parameter
- value (::Integer) — 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.
Returns
- (::Integer) — 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
def target_cidr_range() -> ::Array<::String>
Returns
- (::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" 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.
#target_cidr_range=
def target_cidr_range=(value) -> ::Array<::String>
Parameter
- value (::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" 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.
Returns
- (::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" 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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time when the internal range was updated.
#update_time=
def update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time when the internal range was updated.
Returns
- (::Google::Protobuf::Timestamp) — Time when the internal range was updated.
#usage
def usage() -> ::Google::Cloud::NetworkConnectivity::V1::InternalRange::Usage
Returns
- (::Google::Cloud::NetworkConnectivity::V1::InternalRange::Usage) — Optional. The type of usage set for this InternalRange.
#usage=
def usage=(value) -> ::Google::Cloud::NetworkConnectivity::V1::InternalRange::Usage
Parameter
- value (::Google::Cloud::NetworkConnectivity::V1::InternalRange::Usage) — Optional. The type of usage set for this InternalRange.
Returns
- (::Google::Cloud::NetworkConnectivity::V1::InternalRange::Usage) — Optional. The type of usage set for this InternalRange.
#users
def users() -> ::Array<::String>
Returns
- (::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.