Class ExternalVpnGateway

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

    public final class ExternalVpnGateway
    extends com.google.protobuf.GeneratedMessageV3
    implements ExternalVpnGatewayOrBuilder
     Represents an external VPN gateway. External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.
     
    Protobuf type google.cloud.compute.v1.ExternalVpnGateway
    See Also:
    Serialized Form
    • 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()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

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

        public boolean hasCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        hasCreationTimestamp in interface ExternalVpnGatewayOrBuilder
        Returns:
        Whether the creationTimestamp field is set.
      • getCreationTimestamp

        public String getCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestamp in interface ExternalVpnGatewayOrBuilder
        Returns:
        The creationTimestamp.
      • getCreationTimestampBytes

        public com.google.protobuf.ByteString getCreationTimestampBytes()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestampBytes in interface ExternalVpnGatewayOrBuilder
        Returns:
        The bytes for creationTimestamp.
      • hasDescription

        public boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        hasDescription in interface ExternalVpnGatewayOrBuilder
        Returns:
        Whether the description field is set.
      • getDescription

        public String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        getDescription in interface ExternalVpnGatewayOrBuilder
        Returns:
        The description.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        getDescriptionBytes in interface ExternalVpnGatewayOrBuilder
        Returns:
        The bytes for description.
      • hasId

        public boolean hasId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
         
        optional uint64 id = 3355;
        Specified by:
        hasId in interface ExternalVpnGatewayOrBuilder
        Returns:
        Whether the id field is set.
      • getId

        public long getId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
         
        optional uint64 id = 3355;
        Specified by:
        getId in interface ExternalVpnGatewayOrBuilder
        Returns:
        The id.
      • getInterfacesList

        public List<ExternalVpnGatewayInterface> getInterfacesList()
         A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
         
        repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;
        Specified by:
        getInterfacesList in interface ExternalVpnGatewayOrBuilder
      • getInterfacesOrBuilderList

        public List<? extends ExternalVpnGatewayInterfaceOrBuilder> getInterfacesOrBuilderList()
         A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
         
        repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;
        Specified by:
        getInterfacesOrBuilderList in interface ExternalVpnGatewayOrBuilder
      • getInterfacesCount

        public int getInterfacesCount()
         A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
         
        repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;
        Specified by:
        getInterfacesCount in interface ExternalVpnGatewayOrBuilder
      • getInterfaces

        public ExternalVpnGatewayInterface getInterfaces​(int index)
         A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
         
        repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;
        Specified by:
        getInterfaces in interface ExternalVpnGatewayOrBuilder
      • getInterfacesOrBuilder

        public ExternalVpnGatewayInterfaceOrBuilder getInterfacesOrBuilder​(int index)
         A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
         
        repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;
        Specified by:
        getInterfacesOrBuilder in interface ExternalVpnGatewayOrBuilder
      • hasKind

        public boolean hasKind()
         [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
         
        optional string kind = 3292052;
        Specified by:
        hasKind in interface ExternalVpnGatewayOrBuilder
        Returns:
        Whether the kind field is set.
      • getKind

        public String getKind()
         [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
         
        optional string kind = 3292052;
        Specified by:
        getKind in interface ExternalVpnGatewayOrBuilder
        Returns:
        The kind.
      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
         
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface ExternalVpnGatewayOrBuilder
        Returns:
        The bytes for kind.
      • hasLabelFingerprint

        public boolean hasLabelFingerprint()
         A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
         
        optional string label_fingerprint = 178124825;
        Specified by:
        hasLabelFingerprint in interface ExternalVpnGatewayOrBuilder
        Returns:
        Whether the labelFingerprint field is set.
      • getLabelFingerprint

        public String getLabelFingerprint()
         A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
         
        optional string label_fingerprint = 178124825;
        Specified by:
        getLabelFingerprint in interface ExternalVpnGatewayOrBuilder
        Returns:
        The labelFingerprint.
      • getLabelFingerprintBytes

        public com.google.protobuf.ByteString getLabelFingerprintBytes()
         A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
         
        optional string label_fingerprint = 178124825;
        Specified by:
        getLabelFingerprintBytes in interface ExternalVpnGatewayOrBuilder
        Returns:
        The bytes for labelFingerprint.
      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: ExternalVpnGatewayOrBuilder
         Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
         
        map<string, string> labels = 500195327;
        Specified by:
        getLabelsCount in interface ExternalVpnGatewayOrBuilder
      • containsLabels

        public boolean containsLabels​(String key)
         Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
         
        map<string, string> labels = 500195327;
        Specified by:
        containsLabels in interface ExternalVpnGatewayOrBuilder
      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
         
        map<string, string> labels = 500195327;
        Specified by:
        getLabelsMap in interface ExternalVpnGatewayOrBuilder
      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                         String defaultValue)
         Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
         
        map<string, string> labels = 500195327;
        Specified by:
        getLabelsOrDefault in interface ExternalVpnGatewayOrBuilder
      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
         
        map<string, string> labels = 500195327;
        Specified by:
        getLabelsOrThrow in interface ExternalVpnGatewayOrBuilder
      • hasName

        public boolean hasName()
         Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all 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 ExternalVpnGatewayOrBuilder
        Returns:
        Whether the name field is set.
      • getName

        public String getName()
         Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all 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 ExternalVpnGatewayOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all 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 ExternalVpnGatewayOrBuilder
        Returns:
        The bytes for name.
      • hasRedundancyType

        public boolean hasRedundancyType()
         Indicates the user-supplied redundancy type of this external VPN gateway.
         Check the RedundancyType enum for the list of possible values.
         
        optional string redundancy_type = 271443740;
        Specified by:
        hasRedundancyType in interface ExternalVpnGatewayOrBuilder
        Returns:
        Whether the redundancyType field is set.
      • getRedundancyType

        public String getRedundancyType()
         Indicates the user-supplied redundancy type of this external VPN gateway.
         Check the RedundancyType enum for the list of possible values.
         
        optional string redundancy_type = 271443740;
        Specified by:
        getRedundancyType in interface ExternalVpnGatewayOrBuilder
        Returns:
        The redundancyType.
      • getRedundancyTypeBytes

        public com.google.protobuf.ByteString getRedundancyTypeBytes()
         Indicates the user-supplied redundancy type of this external VPN gateway.
         Check the RedundancyType enum for the list of possible values.
         
        optional string redundancy_type = 271443740;
        Specified by:
        getRedundancyTypeBytes in interface ExternalVpnGatewayOrBuilder
        Returns:
        The bytes for redundancyType.
      • hasSelfLink

        public boolean hasSelfLink()
         [Output Only] Server-defined URL for the resource.
         
        optional string self_link = 456214797;
        Specified by:
        hasSelfLink in interface ExternalVpnGatewayOrBuilder
        Returns:
        Whether the selfLink field is set.
      • getSelfLink

        public String getSelfLink()
         [Output Only] Server-defined URL for the resource.
         
        optional string self_link = 456214797;
        Specified by:
        getSelfLink in interface ExternalVpnGatewayOrBuilder
        Returns:
        The selfLink.
      • getSelfLinkBytes

        public com.google.protobuf.ByteString getSelfLinkBytes()
         [Output Only] Server-defined URL for the resource.
         
        optional string self_link = 456214797;
        Specified by:
        getSelfLinkBytes in interface ExternalVpnGatewayOrBuilder
        Returns:
        The bytes for selfLink.
      • 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 ExternalVpnGateway parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public com.google.protobuf.Parser<ExternalVpnGateway> 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 ExternalVpnGateway getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder