Class: Google::Apis::ComputeV1::NetworkPeering

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NetworkPeering

Returns a new instance of NetworkPeering.



25458
25459
25460
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25458

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

Instance Attribute Details

#auto_create_routes ⇒ Boolean Also known as: auto_create_routes?

This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. Corresponds to the JSON property autoCreateRoutes

Returns:

  • (Boolean) 


25376
25377
25378
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25376

def auto_create_routes
  @auto_create_routes
end

#exchange_subnet_routes ⇒ Boolean Also known as: exchange_subnet_routes?

Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. Corresponds to the JSON property exchangeSubnetRoutes

Returns:

  • (Boolean) 


25385
25386
25387
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25385

def exchange_subnet_routes
  @exchange_subnet_routes
end

#export_custom_routes ⇒ Boolean Also known as: export_custom_routes?

Whether to export the custom routes to peer network. The default value is false. Corresponds to the JSON property exportCustomRoutes

Returns:

  • (Boolean) 


25392
25393
25394
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25392

def export_custom_routes
  @export_custom_routes
end

#export_subnet_routes_with_public_ip ⇒ Boolean Also known as: export_subnet_routes_with_public_ip?

Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field. Corresponds to the JSON property exportSubnetRoutesWithPublicIp

Returns:

  • (Boolean) 


25400
25401
25402
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25400

def export_subnet_routes_with_public_ip
  @export_subnet_routes_with_public_ip
end

#import_custom_routes ⇒ Boolean Also known as: import_custom_routes?

Whether to import the custom routes from peer network. The default value is false. Corresponds to the JSON property importCustomRoutes

Returns:

  • (Boolean) 


25407
25408
25409
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25407

def import_custom_routes
  @import_custom_routes
end

#import_subnet_routes_with_public_ip ⇒ Boolean Also known as: import_subnet_routes_with_public_ip?

Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field. Corresponds to the JSON property importSubnetRoutesWithPublicIp

Returns:

  • (Boolean) 


25415
25416
25417
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25415

def import_subnet_routes_with_public_ip
  @import_subnet_routes_with_public_ip
end

#name ⇒ String

Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property name

Returns:

  • (String) 


25426
25427
25428
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25426

def name
  @name
end

#network ⇒ String

The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. Corresponds to the JSON property network

Returns:

  • (String) 


25434
25435
25436
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25434

def network
  @network
end

#peer_mtu ⇒ Fixnum

Maximum Transmission Unit in bytes. Corresponds to the JSON property peerMtu

Returns:

  • (Fixnum) 


25439
25440
25441
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25439

def peer_mtu
  @peer_mtu
end

#stack_type ⇒ String

Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY. Corresponds to the JSON property stackType

Returns:

  • (String) 


25445
25446
25447
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25445

def stack_type
  @stack_type
end

#state ⇒ String

[Output Only] State for the peering, either ACTIVE or INACTIVE. The peering is ACTIVE when there's a matching configuration in the peer network. Corresponds to the JSON property state

Returns:

  • (String) 


25451
25452
25453
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25451

def state
  @state
end

#state_details ⇒ String

[Output Only] Details about the current state of the peering. Corresponds to the JSON property stateDetails

Returns:

  • (String) 


25456
25457
25458
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25456

def state_details
  @state_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



25463
25464
25465
25466
25467
25468
25469
25470
25471
25472
25473
25474
25475
25476
 
# File 'lib/google/apis/compute_v1/classes.rb', line 25463

def update!(**args)
  @auto_create_routes = args[:auto_create_routes] if args.key?(:auto_create_routes)
  @exchange_subnet_routes = args[:exchange_subnet_routes] if args.key?(:exchange_subnet_routes)
  @export_custom_routes = args[:export_custom_routes] if args.key?(:export_custom_routes)
  @export_subnet_routes_with_public_ip = args[:export_subnet_routes_with_public_ip] if args.key?(:export_subnet_routes_with_public_ip)
  @import_custom_routes = args[:import_custom_routes] if args.key?(:import_custom_routes)
  @import_subnet_routes_with_public_ip = args[:import_subnet_routes_with_public_ip] if args.key?(:import_subnet_routes_with_public_ip)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @peer_mtu = args[:peer_mtu] if args.key?(:peer_mtu)
  @stack_type = args[:stack_type] if args.key?(:stack_type)
  @state = args[:state] if args.key?(:state)
  @state_details = args[:state_details] if args.key?(:state_details)
end