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.



33193
33194
33195
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33193

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 theexchange_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 isACTIVE. Corresponds to the JSON property autoCreateRoutes

Returns:

  • (Boolean) 


33091
33092
33093
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33091

def auto_create_routes
  @auto_create_routes
end

#connection_status ⇒ Google::Apis::ComputeV1::NetworkPeeringConnectionStatus

[Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings. Corresponds to the JSON property connectionStatus

Returns:



33100
33101
33102
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33100

def connection_status
  @connection_status
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 isACTIVE. Corresponds to the JSON property exchangeSubnetRoutes

Returns:

  • (Boolean) 


33108
33109
33110
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33108

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) 


33115
33116
33117
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33115

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) 


33124
33125
33126
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33124

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) 


33131
33132
33133
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33131

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) 


33140
33141
33142
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33140

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


33152
33153
33154
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33152

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) 


33160
33161
33162
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33160

def network
  @network
end

#peer_mtu ⇒ Fixnum

Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network. Corresponds to the JSON property peerMtu

Returns:

  • (Fixnum) 


33166
33167
33168
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33166

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) 


33172
33173
33174
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33172

def stack_type
  @stack_type
end

#state ⇒ String

Output only. [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) 


33180
33181
33182
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33180

def state
  @state
end

#state_details ⇒ String

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

Returns:

  • (String) 


33185
33186
33187
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33185

def state_details
  @state_details
end

#update_strategy ⇒ String

The update strategy determines the semantics for updates and deletes to the peering connection configuration. Corresponds to the JSON property updateStrategy

Returns:

  • (String) 


33191
33192
33193
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33191

def update_strategy
  @update_strategy
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



33198
33199
33200
33201
33202
33203
33204
33205
33206
33207
33208
33209
33210
33211
33212
33213
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33198

def update!(**args)
  @auto_create_routes = args[:auto_create_routes] if args.key?(:auto_create_routes)
  @connection_status = args[:connection_status] if args.key?(:connection_status)
  @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)
  @update_strategy = args[:update_strategy] if args.key?(:update_strategy)
end