Class: Google::Cloud::Compute::V1::NetworkPeering

Inherits:

Object

Object
Google::Cloud::Compute::V1::NetworkPeering

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/compute/v1/compute.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.

Defined Under Namespace

Modules: StackType, State

Instance Attribute Summary collapse

#auto_create_routes ⇒ ::Boolean
This field will be deprecated soon.
#exchange_subnet_routes ⇒ ::Boolean
Indicates whether full mesh connectivity is created and managed automatically between peered networks.
#export_custom_routes ⇒ ::Boolean
Whether to export the custom routes to peer network.
#export_subnet_routes_with_public_ip ⇒ ::Boolean
Whether subnet routes with public IP range are exported.
#import_custom_routes ⇒ ::Boolean
Whether to import the custom routes from peer network.
#import_subnet_routes_with_public_ip ⇒ ::Boolean
Whether subnet routes with public IP range are imported.
#name ⇒ ::String
Name of this peering.
#network ⇒ ::String
The URL of the peer network.
#peer_mtu ⇒ ::Integer
Maximum Transmission Unit in bytes.
#stack_type ⇒ ::String
Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks.
#state ⇒ ::String
[Output Only] State for the peering, either ACTIVE or INACTIVE.
#state_details ⇒ ::String
[Output Only] Details about the current state of the peering.

Instance Attribute Details

#auto_create_routes ⇒ `::Boolean`

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

Returns:

(::Boolean) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#exchange_subnet_routes ⇒ `::Boolean`

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

Returns:

(::Boolean) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#export_custom_routes ⇒ `::Boolean`

Returns Whether to export the custom routes to peer network. The default value is false.

Returns:

(::Boolean) —
Whether to export the custom routes to peer network. The default value is false.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#export_subnet_routes_with_public_ip ⇒ `::Boolean`

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

Returns:

(::Boolean) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#import_custom_routes ⇒ `::Boolean`

Returns Whether to import the custom routes from peer network. The default value is false.

Returns:

(::Boolean) —
Whether to import the custom routes from peer network. The default value is false.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#import_subnet_routes_with_public_ip ⇒ `::Boolean`

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

Returns:

(::Boolean) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#name ⇒ `::String`

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

Returns:

(::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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#network ⇒ `::String`

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

Returns:

(::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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#peer_mtu ⇒ `::Integer`

Returns Maximum Transmission Unit in bytes.

Returns:

(::Integer) —
Maximum Transmission Unit in bytes.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#stack_type ⇒ `::String`

Returns Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY. Check the StackType enum for the list of possible values.

Returns:

(::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. Check the StackType enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#state ⇒ `::String`

Returns [Output Only] State for the peering, either ACTIVE or INACTIVE. The peering is ACTIVE when there's a matching configuration in the peer network. Check the State enum for the list of possible values.

Returns:

(::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. Check the State enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

#state_details ⇒ `::String`

Returns [Output Only] Details about the current state of the peering.

Returns:

(::String) —
[Output Only] Details about the current state of the peering.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 18351

class NetworkPeering
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
  module StackType
    # A value indicating that the enum field is not set.
    UNDEFINED_STACK_TYPE = 0

    # This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.
    IPV4_IPV6 = 22197249

    # This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
    IPV4_ONLY = 22373798
  end

  # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
  module State
    # A value indicating that the enum field is not set.
    UNDEFINED_STATE = 0

    # Matching configuration exists on the peer.
    ACTIVE = 314733318

    # There is no matching configuration on the peer, including the case when peer does not exist.
    INACTIVE = 270421099
  end
end

Class: Google::Cloud::Compute::V1::NetworkPeering

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#auto_create_routes ⇒ ::Boolean

#exchange_subnet_routes ⇒ ::Boolean

#export_custom_routes ⇒ ::Boolean

#export_subnet_routes_with_public_ip ⇒ ::Boolean

#import_custom_routes ⇒ ::Boolean

#import_subnet_routes_with_public_ip ⇒ ::Boolean

#name ⇒ ::String

#network ⇒ ::String

#peer_mtu ⇒ ::Integer

#stack_type ⇒ ::String

#state ⇒ ::String

#state_details ⇒ ::String

#auto_create_routes ⇒ `::Boolean`

#exchange_subnet_routes ⇒ `::Boolean`

#export_custom_routes ⇒ `::Boolean`

#export_subnet_routes_with_public_ip ⇒ `::Boolean`

#import_custom_routes ⇒ `::Boolean`

#import_subnet_routes_with_public_ip ⇒ `::Boolean`

#name ⇒ `::String`

#network ⇒ `::String`

#peer_mtu ⇒ `::Integer`

#stack_type ⇒ `::String`

#state ⇒ `::String`

#state_details ⇒ `::String`