Package com.google.cloud.compute.v1

Class TargetVpnGateway

  • All Implemented Interfaces:
    TargetVpnGatewayOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TargetVpnGateway
extends com.google.protobuf.GeneratedMessageV3
implements TargetVpnGatewayOrBuilder
     Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview.
    Protobuf type google.cloud.compute.v1.TargetVpnGateway
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TargetVpnGateway.Builder
      Represents a Target VPN Gateway resource.
      static class  TargetVpnGateway.Status
      [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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 TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        Returns:
        The bytes for description.

      • getForwardingRulesList

        public com.google.protobuf.ProtocolStringList getForwardingRulesList()
         [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
        repeated string forwarding_rules = 315821365;
        Specified by:
        getForwardingRulesList in interface TargetVpnGatewayOrBuilder
        Returns:
        A list containing the forwardingRules.

      • getForwardingRulesCount

        public int getForwardingRulesCount()
         [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
        repeated string forwarding_rules = 315821365;
        Specified by:
        getForwardingRulesCount in interface TargetVpnGatewayOrBuilder
        Returns:
        The count of forwardingRules.

      • getForwardingRules

        public String getForwardingRules​(int index)
         [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
        repeated string forwarding_rules = 315821365;
        Specified by:
        getForwardingRules in interface TargetVpnGatewayOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The forwardingRules at the given index.

      • getForwardingRulesBytes

        public com.google.protobuf.ByteString getForwardingRulesBytes​(int index)
         [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
        repeated string forwarding_rules = 315821365;
        Specified by:
        getForwardingRulesBytes in interface TargetVpnGatewayOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the forwardingRules at the given index.

      • 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 TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        Returns:
        The id.

      • hasKind

        public boolean hasKind()
         [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
        optional string kind = 3292052;
        Specified by:
        hasKind in interface TargetVpnGatewayOrBuilder
        Returns:
        Whether the kind field is set.

      • getKind

        public String getKind()
         [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
        optional string kind = 3292052;
        Specified by:
        getKind in interface TargetVpnGatewayOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface TargetVpnGatewayOrBuilder
        Returns:
        The bytes for kind.

      • hasLabelFingerprint

        public boolean hasLabelFingerprint()
         A fingerprint for the labels being applied to this TargetVpnGateway, 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 a TargetVpnGateway.
        optional string label_fingerprint = 178124825;
        Specified by:
        hasLabelFingerprint in interface TargetVpnGatewayOrBuilder
        Returns:
        Whether the labelFingerprint field is set.

      • getLabelFingerprint

        public String getLabelFingerprint()
         A fingerprint for the labels being applied to this TargetVpnGateway, 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 a TargetVpnGateway.
        optional string label_fingerprint = 178124825;
        Specified by:
        getLabelFingerprint in interface TargetVpnGatewayOrBuilder
        Returns:
        The labelFingerprint.

      • getLabelFingerprintBytes

        public com.google.protobuf.ByteString getLabelFingerprintBytes()
         A fingerprint for the labels being applied to this TargetVpnGateway, 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 a TargetVpnGateway.
        optional string label_fingerprint = 178124825;
        Specified by:
        getLabelFingerprintBytes in interface TargetVpnGatewayOrBuilder
        Returns:
        The bytes for labelFingerprint.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: TargetVpnGatewayOrBuilder
         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 TargetVpnGatewayOrBuilder

      • 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 TargetVpnGatewayOrBuilder

      • 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 TargetVpnGatewayOrBuilder

      • 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 TargetVpnGatewayOrBuilder

      • 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 TargetVpnGatewayOrBuilder

      • 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 TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        Returns:
        The bytes for name.

      • hasNetwork

        public boolean hasNetwork()
         URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
        optional string network = 232872494;
        Specified by:
        hasNetwork in interface TargetVpnGatewayOrBuilder
        Returns:
        Whether the network field is set.

      • getNetwork

        public String getNetwork()
         URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
        optional string network = 232872494;
        Specified by:
        getNetwork in interface TargetVpnGatewayOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
        optional string network = 232872494;
        Specified by:
        getNetworkBytes in interface TargetVpnGatewayOrBuilder
        Returns:
        The bytes for network.

      • hasRegion

        public boolean hasRegion()
         [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        optional string region = 138946292;
        Specified by:
        hasRegion in interface TargetVpnGatewayOrBuilder
        Returns:
        Whether the region field is set.

      • getRegion

        public String getRegion()
         [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        optional string region = 138946292;
        Specified by:
        getRegion in interface TargetVpnGatewayOrBuilder
        Returns:
        The region.

      • getRegionBytes

        public com.google.protobuf.ByteString getRegionBytes()
         [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        optional string region = 138946292;
        Specified by:
        getRegionBytes in interface TargetVpnGatewayOrBuilder
        Returns:
        The bytes for region.

      • hasSelfLink

        public boolean hasSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        hasSelfLink in interface TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        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 TargetVpnGatewayOrBuilder
        Returns:
        The bytes for selfLink.

      • hasStatus

        public boolean hasStatus()
         [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
 Check the Status enum for the list of possible values.
        optional string status = 181260274;
        Specified by:
        hasStatus in interface TargetVpnGatewayOrBuilder
        Returns:
        Whether the status field is set.

      • getStatus

        public String getStatus()
         [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
 Check the Status enum for the list of possible values.
        optional string status = 181260274;
        Specified by:
        getStatus in interface TargetVpnGatewayOrBuilder
        Returns:
        The status.

      • getStatusBytes

        public com.google.protobuf.ByteString getStatusBytes()
         [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
 Check the Status enum for the list of possible values.
        optional string status = 181260274;
        Specified by:
        getStatusBytes in interface TargetVpnGatewayOrBuilder
        Returns:
        The bytes for status.

      • getTunnelsList

        public com.google.protobuf.ProtocolStringList getTunnelsList()
         [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
        repeated string tunnels = 104561931;
        Specified by:
        getTunnelsList in interface TargetVpnGatewayOrBuilder
        Returns:
        A list containing the tunnels.

      • getTunnelsCount

        public int getTunnelsCount()
         [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
        repeated string tunnels = 104561931;
        Specified by:
        getTunnelsCount in interface TargetVpnGatewayOrBuilder
        Returns:
        The count of tunnels.

      • getTunnels

        public String getTunnels​(int index)
         [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
        repeated string tunnels = 104561931;
        Specified by:
        getTunnels in interface TargetVpnGatewayOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The tunnels at the given index.

      • getTunnelsBytes

        public com.google.protobuf.ByteString getTunnelsBytes​(int index)
         [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
        repeated string tunnels = 104561931;
        Specified by:
        getTunnelsBytes in interface TargetVpnGatewayOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the tunnels at the given index.

      • 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 TargetVpnGateway parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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