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 characterstics 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.



964
965
966
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 964

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


884
885
886
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 884

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


889
890
891
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 889

def description
  @description
end

#ip_cidr_range ⇒ String

The IP range that this internal range defines. Corresponds to the JSON property ipCidrRange

Returns:

  • (String) 


894
895
896
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 894

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


899
900
901
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 899

def labels
  @labels
end

#name ⇒ String

Immutable. 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) 


906
907
908
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 906

def name
  @name
end

#network ⇒ String

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. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/project/ global/networks/resourceId - ID: network123 Corresponds to the JSON property network

Returns:

  • (String) 


915
916
917
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 915

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


921
922
923
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 921

def overlaps
  @overlaps
end

#peering ⇒ String

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

Returns:

  • (String) 


926
927
928
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 926

def peering
  @peering
end

#prefix_length ⇒ Fixnum

An alternate to ip_cidr_range. Can be set when trying to create a 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. Corresponds to the JSON property prefixLength

Returns:

  • (Fixnum) 


934
935
936
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 934

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

Returns:

  • (Array<String>) 


942
943
944
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 942

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) 


947
948
949
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 947

def update_time
  @update_time
end

#usage ⇒ String

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

Returns:

  • (String) 


952
953
954
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 952

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


962
963
964
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 962

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 969

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
  @labels = args[:labels] if args.key?(:labels)
  @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