Class NetworkPeering

  • All Implemented Interfaces:
    NetworkPeeringOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class NetworkPeering
    extends com.google.protobuf.GeneratedMessageV3
    implements NetworkPeeringOrBuilder
     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.
     
    Protobuf type google.cloud.compute.v1.NetworkPeering
    See Also:
    Serialized Form
    • Field Detail

      • AUTO_CREATE_ROUTES_FIELD_NUMBER

        public static final int AUTO_CREATE_ROUTES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXCHANGE_SUBNET_ROUTES_FIELD_NUMBER

        public static final int EXCHANGE_SUBNET_ROUTES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXPORT_CUSTOM_ROUTES_FIELD_NUMBER

        public static final int EXPORT_CUSTOM_ROUTES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXPORT_SUBNET_ROUTES_WITH_PUBLIC_IP_FIELD_NUMBER

        public static final int EXPORT_SUBNET_ROUTES_WITH_PUBLIC_IP_FIELD_NUMBER
        See Also:
        Constant Field Values
      • IMPORT_CUSTOM_ROUTES_FIELD_NUMBER

        public static final int IMPORT_CUSTOM_ROUTES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • IMPORT_SUBNET_ROUTES_WITH_PUBLIC_IP_FIELD_NUMBER

        public static final int IMPORT_SUBNET_ROUTES_WITH_PUBLIC_IP_FIELD_NUMBER
        See Also:
        Constant Field Values
      • STACK_TYPE_FIELD_NUMBER

        public static final int STACK_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • STATE_DETAILS_FIELD_NUMBER

        public static final int STATE_DETAILS_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasAutoCreateRoutes

        public boolean hasAutoCreateRoutes()
         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.
         
        optional bool auto_create_routes = 57454941;
        Specified by:
        hasAutoCreateRoutes in interface NetworkPeeringOrBuilder
        Returns:
        Whether the autoCreateRoutes field is set.
      • getAutoCreateRoutes

        public boolean getAutoCreateRoutes()
         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.
         
        optional bool auto_create_routes = 57454941;
        Specified by:
        getAutoCreateRoutes in interface NetworkPeeringOrBuilder
        Returns:
        The autoCreateRoutes.
      • hasExchangeSubnetRoutes

        public boolean hasExchangeSubnetRoutes()
         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.
         
        optional bool exchange_subnet_routes = 26322256;
        Specified by:
        hasExchangeSubnetRoutes in interface NetworkPeeringOrBuilder
        Returns:
        Whether the exchangeSubnetRoutes field is set.
      • getExchangeSubnetRoutes

        public boolean getExchangeSubnetRoutes()
         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.
         
        optional bool exchange_subnet_routes = 26322256;
        Specified by:
        getExchangeSubnetRoutes in interface NetworkPeeringOrBuilder
        Returns:
        The exchangeSubnetRoutes.
      • hasExportCustomRoutes

        public boolean hasExportCustomRoutes()
         Whether to export the custom routes to peer network. The default value is false.
         
        optional bool export_custom_routes = 60281485;
        Specified by:
        hasExportCustomRoutes in interface NetworkPeeringOrBuilder
        Returns:
        Whether the exportCustomRoutes field is set.
      • getExportCustomRoutes

        public boolean getExportCustomRoutes()
         Whether to export the custom routes to peer network. The default value is false.
         
        optional bool export_custom_routes = 60281485;
        Specified by:
        getExportCustomRoutes in interface NetworkPeeringOrBuilder
        Returns:
        The exportCustomRoutes.
      • hasExportSubnetRoutesWithPublicIp

        public boolean hasExportSubnetRoutesWithPublicIp()
         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.
         
        optional bool export_subnet_routes_with_public_ip = 97940834;
        Specified by:
        hasExportSubnetRoutesWithPublicIp in interface NetworkPeeringOrBuilder
        Returns:
        Whether the exportSubnetRoutesWithPublicIp field is set.
      • getExportSubnetRoutesWithPublicIp

        public boolean getExportSubnetRoutesWithPublicIp()
         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.
         
        optional bool export_subnet_routes_with_public_ip = 97940834;
        Specified by:
        getExportSubnetRoutesWithPublicIp in interface NetworkPeeringOrBuilder
        Returns:
        The exportSubnetRoutesWithPublicIp.
      • hasImportCustomRoutes

        public boolean hasImportCustomRoutes()
         Whether to import the custom routes from peer network. The default value is false.
         
        optional bool import_custom_routes = 197982398;
        Specified by:
        hasImportCustomRoutes in interface NetworkPeeringOrBuilder
        Returns:
        Whether the importCustomRoutes field is set.
      • getImportCustomRoutes

        public boolean getImportCustomRoutes()
         Whether to import the custom routes from peer network. The default value is false.
         
        optional bool import_custom_routes = 197982398;
        Specified by:
        getImportCustomRoutes in interface NetworkPeeringOrBuilder
        Returns:
        The importCustomRoutes.
      • hasImportSubnetRoutesWithPublicIp

        public boolean hasImportSubnetRoutesWithPublicIp()
         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.
         
        optional bool import_subnet_routes_with_public_ip = 14419729;
        Specified by:
        hasImportSubnetRoutesWithPublicIp in interface NetworkPeeringOrBuilder
        Returns:
        Whether the importSubnetRoutesWithPublicIp field is set.
      • getImportSubnetRoutesWithPublicIp

        public boolean getImportSubnetRoutesWithPublicIp()
         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.
         
        optional bool import_subnet_routes_with_public_ip = 14419729;
        Specified by:
        getImportSubnetRoutesWithPublicIp in interface NetworkPeeringOrBuilder
        Returns:
        The importSubnetRoutesWithPublicIp.
      • hasName

        public boolean hasName()
         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.
         
        optional string name = 3373707;
        Specified by:
        hasName in interface NetworkPeeringOrBuilder
        Returns:
        Whether the name field is set.
      • getName

        public String getName()
         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.
         
        optional string name = 3373707;
        Specified by:
        getName in interface NetworkPeeringOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         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.
         
        optional string name = 3373707;
        Specified by:
        getNameBytes in interface NetworkPeeringOrBuilder
        Returns:
        The bytes for name.
      • hasNetwork

        public boolean hasNetwork()
         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.
         
        optional string network = 232872494;
        Specified by:
        hasNetwork in interface NetworkPeeringOrBuilder
        Returns:
        Whether the network field is set.
      • getNetwork

        public String getNetwork()
         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.
         
        optional string network = 232872494;
        Specified by:
        getNetwork in interface NetworkPeeringOrBuilder
        Returns:
        The network.
      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         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.
         
        optional string network = 232872494;
        Specified by:
        getNetworkBytes in interface NetworkPeeringOrBuilder
        Returns:
        The bytes for network.
      • hasPeerMtu

        public boolean hasPeerMtu()
         Maximum Transmission Unit in bytes.
         
        optional int32 peer_mtu = 69584721;
        Specified by:
        hasPeerMtu in interface NetworkPeeringOrBuilder
        Returns:
        Whether the peerMtu field is set.
      • getPeerMtu

        public int getPeerMtu()
         Maximum Transmission Unit in bytes.
         
        optional int32 peer_mtu = 69584721;
        Specified by:
        getPeerMtu in interface NetworkPeeringOrBuilder
        Returns:
        The peerMtu.
      • hasStackType

        public boolean hasStackType()
         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.
         
        optional string stack_type = 425908881;
        Specified by:
        hasStackType in interface NetworkPeeringOrBuilder
        Returns:
        Whether the stackType field is set.
      • getStackType

        public String getStackType()
         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.
         
        optional string stack_type = 425908881;
        Specified by:
        getStackType in interface NetworkPeeringOrBuilder
        Returns:
        The stackType.
      • getStackTypeBytes

        public com.google.protobuf.ByteString getStackTypeBytes()
         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.
         
        optional string stack_type = 425908881;
        Specified by:
        getStackTypeBytes in interface NetworkPeeringOrBuilder
        Returns:
        The bytes for stackType.
      • hasState

        public boolean hasState()
         [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.
         
        optional string state = 109757585;
        Specified by:
        hasState in interface NetworkPeeringOrBuilder
        Returns:
        Whether the state field is set.
      • getState

        public String getState()
         [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.
         
        optional string state = 109757585;
        Specified by:
        getState in interface NetworkPeeringOrBuilder
        Returns:
        The state.
      • getStateBytes

        public com.google.protobuf.ByteString getStateBytes()
         [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.
         
        optional string state = 109757585;
        Specified by:
        getStateBytes in interface NetworkPeeringOrBuilder
        Returns:
        The bytes for state.
      • hasStateDetails

        public boolean hasStateDetails()
         [Output Only] Details about the current state of the peering.
         
        optional string state_details = 95566996;
        Specified by:
        hasStateDetails in interface NetworkPeeringOrBuilder
        Returns:
        Whether the stateDetails field is set.
      • getStateDetails

        public String getStateDetails()
         [Output Only] Details about the current state of the peering.
         
        optional string state_details = 95566996;
        Specified by:
        getStateDetails in interface NetworkPeeringOrBuilder
        Returns:
        The stateDetails.
      • getStateDetailsBytes

        public com.google.protobuf.ByteString getStateDetailsBytes()
         [Output Only] Details about the current state of the peering.
         
        optional string state_details = 95566996;
        Specified by:
        getStateDetailsBytes in interface NetworkPeeringOrBuilder
        Returns:
        The bytes for stateDetails.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static NetworkPeering parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static NetworkPeering parseFrom​(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static NetworkPeering parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static NetworkPeering parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static NetworkPeering parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static NetworkPeering parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static NetworkPeering parseFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Throws:
        IOException
      • newBuilderForType

        public NetworkPeering.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public NetworkPeering.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected NetworkPeering.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static NetworkPeering getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<NetworkPeering> parser()
      • getParserForType

        public com.google.protobuf.Parser<NetworkPeering> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public NetworkPeering getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder