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

Inherits:
Object
  • Object
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: State

Instance Attribute Summary collapse

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.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.

Returns:

  • (::Boolean) —

    Whether to export the custom routes to peer network.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.

Returns:

  • (::Boolean) —

    Whether to import the custom routes from peer network.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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.



16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 16083

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

  # [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