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.



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

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) 


826
827
828
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 826

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


831
832
833
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 831

def description
  @description
end

#ip_cidr_range ⇒ String

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

Returns:

  • (String) 


836
837
838
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 836

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


841
842
843
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 841

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) 


848
849
850
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 848

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) 


857
858
859
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 857

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


863
864
865
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 863

def overlaps
  @overlaps
end

#peering ⇒ String

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

Returns:

  • (String) 


868
869
870
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 868

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) 


876
877
878
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 876

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


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

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) 


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

def update_time
  @update_time
end

#usage ⇒ String

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

Returns:

  • (String) 


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

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


904
905
906
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 904

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 911

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