Class: Google::Apis::NetworkconnectivityV1::Route

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

A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Route

Returns a new instance of Route.



1870
1871
1872
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1870

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time the route was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1803
1804
1805
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1803

def create_time
  @create_time
end

#description ⇒ String

An optional description of the route. Corresponds to the JSON property description

Returns:

  • (String) 


1808
1809
1810
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1808

def description
  @description
end

#ip_cidr_range ⇒ String

The destination IP address range. Corresponds to the JSON property ipCidrRange

Returns:

  • (String) 


1813
1814
1815
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1813

def ip_cidr_range
  @ip_cidr_range
end

#labels ⇒ Hash<String,String>

Optional labels in key:value format. For more information about labels, see Requirements for labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1820
1821
1822
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1820

def labels
  @labels
end

#location ⇒ String

Output only. The location of the route. Uses the following form: "projects/ project/locations/location" Example: projects/1234/locations/us-central1 Corresponds to the JSON property location

Returns:

  • (String) 


1826
1827
1828
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1826

def location
  @location
end

#name ⇒ String

Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/project_number/locations/global/hubs/hub/ routeTables/route_table_id/routes/route_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


1833
1834
1835
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1833

def name
  @name
end

#next_hop_vpc_network ⇒ Google::Apis::NetworkconnectivityV1::NextHopVpcNetwork

Immutable. The destination VPC network for packets on this route. Corresponds to the JSON property nextHopVpcNetwork

Returns:



1838
1839
1840
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1838

def next_hop_vpc_network
  @next_hop_vpc_network
end

#spoke ⇒ String

Immutable. The spoke that this route leads to. Example: projects/12345/ locations/global/spokes/SPOKE Corresponds to the JSON property spoke

Returns:

  • (String) 


1844
1845
1846
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1844

def spoke
  @spoke
end

#state ⇒ String

Output only. The current lifecycle state of the route. Corresponds to the JSON property state

Returns:

  • (String) 


1849
1850
1851
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1849

def state
  @state
end

#type ⇒ String

Output only. The route's type. Its type is determined by the properties of its IP address range. Corresponds to the JSON property type

Returns:

  • (String) 


1855
1856
1857
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1855

def type
  @type
end

#uid ⇒ String

Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid. Corresponds to the JSON property uid

Returns:

  • (String) 


1863
1864
1865
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1863

def uid
  @uid
end

#update_time ⇒ String

Output only. The time the route was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1868
1869
1870
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1868

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1875

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)
  @location = args[:location] if args.key?(:location)
  @name = args[:name] if args.key?(:name)
  @next_hop_vpc_network = args[:next_hop_vpc_network] if args.key?(:next_hop_vpc_network)
  @spoke = args[:spoke] if args.key?(:spoke)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end