Class VpnGateway

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.VpnGateway
All Implemented Interfaces:
VpnGatewayOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class VpnGateway extends com.google.protobuf.GeneratedMessage implements VpnGatewayOrBuilder
 Represents a HA VPN gateway.

 HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely
 connect your on-premises network to your Google Cloud Virtual Private Cloud
 network through an IPsec VPN connection in a single region.
 For more information about Cloud HA VPN solutions, see
 Cloud VPN topologies .
 
Protobuf type google.cloud.compute.v1.VpnGateway
See Also:
  • Field Details

  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

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

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

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

      public com.google.protobuf.ByteString getCreationTimestampBytes()
       Output only. [Output Only] Creation timestamp inRFC3339
       text format.
       
      optional string creation_timestamp = 30525366;
      Specified by:
      getCreationTimestampBytes in interface VpnGatewayOrBuilder
      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 VpnGatewayOrBuilder
      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 VpnGatewayOrBuilder
      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 VpnGatewayOrBuilder
      Returns:
      The bytes for description.
    • hasGatewayIpVersion

      public boolean hasGatewayIpVersion()
       The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
       specified, IPV4 will be used.
       Check the GatewayIpVersion enum for the list of possible values.
       
      optional string gateway_ip_version = 65074843;
      Specified by:
      hasGatewayIpVersion in interface VpnGatewayOrBuilder
      Returns:
      Whether the gatewayIpVersion field is set.
    • getGatewayIpVersion

      public String getGatewayIpVersion()
       The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
       specified, IPV4 will be used.
       Check the GatewayIpVersion enum for the list of possible values.
       
      optional string gateway_ip_version = 65074843;
      Specified by:
      getGatewayIpVersion in interface VpnGatewayOrBuilder
      Returns:
      The gatewayIpVersion.
    • getGatewayIpVersionBytes

      public com.google.protobuf.ByteString getGatewayIpVersionBytes()
       The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
       specified, IPV4 will be used.
       Check the GatewayIpVersion enum for the list of possible values.
       
      optional string gateway_ip_version = 65074843;
      Specified by:
      getGatewayIpVersionBytes in interface VpnGatewayOrBuilder
      Returns:
      The bytes for gatewayIpVersion.
    • hasId

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

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

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

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

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

      public boolean hasLabelFingerprint()
       A fingerprint for the labels being applied to this VpnGateway, 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 error412 conditionNotMet.
      
       To see the latest fingerprint, make a get() request to
       retrieve a VpnGateway.
       
      optional string label_fingerprint = 178124825;
      Specified by:
      hasLabelFingerprint in interface VpnGatewayOrBuilder
      Returns:
      Whether the labelFingerprint field is set.
    • getLabelFingerprint

      public String getLabelFingerprint()
       A fingerprint for the labels being applied to this VpnGateway, 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 error412 conditionNotMet.
      
       To see the latest fingerprint, make a get() request to
       retrieve a VpnGateway.
       
      optional string label_fingerprint = 178124825;
      Specified by:
      getLabelFingerprint in interface VpnGatewayOrBuilder
      Returns:
      The labelFingerprint.
    • getLabelFingerprintBytes

      public com.google.protobuf.ByteString getLabelFingerprintBytes()
       A fingerprint for the labels being applied to this VpnGateway, 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 error412 conditionNotMet.
      
       To see the latest fingerprint, make a get() request to
       retrieve a VpnGateway.
       
      optional string label_fingerprint = 178124825;
      Specified by:
      getLabelFingerprintBytes in interface VpnGatewayOrBuilder
      Returns:
      The bytes for labelFingerprint.
    • getLabelsCount

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

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

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface VpnGatewayOrBuilder
    • getLabelsMap

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

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

      public String getLabelsOrThrow(String key)
       Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
       Label values may be empty.
       
      map<string, string> labels = 500195327;
      Specified by:
      getLabelsOrThrow in interface VpnGatewayOrBuilder
    • 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 withRFC1035.
       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 VpnGatewayOrBuilder
      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 withRFC1035.
       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 VpnGatewayOrBuilder
      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 withRFC1035.
       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 VpnGatewayOrBuilder
      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 VpnGatewayOrBuilder
      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 VpnGatewayOrBuilder
      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 VpnGatewayOrBuilder
      Returns:
      The bytes for network.
    • hasParams

      public boolean hasParams()
       Input only. [Input Only] Additional params passed with the request, but not persisted
       as part of resource payload.
       
      optional .google.cloud.compute.v1.VpnGatewayParams params = 78313862;
      Specified by:
      hasParams in interface VpnGatewayOrBuilder
      Returns:
      Whether the params field is set.
    • getParams

      public VpnGatewayParams getParams()
       Input only. [Input Only] Additional params passed with the request, but not persisted
       as part of resource payload.
       
      optional .google.cloud.compute.v1.VpnGatewayParams params = 78313862;
      Specified by:
      getParams in interface VpnGatewayOrBuilder
      Returns:
      The params.
    • getParamsOrBuilder

      public VpnGatewayParamsOrBuilder getParamsOrBuilder()
       Input only. [Input Only] Additional params passed with the request, but not persisted
       as part of resource payload.
       
      optional .google.cloud.compute.v1.VpnGatewayParams params = 78313862;
      Specified by:
      getParamsOrBuilder in interface VpnGatewayOrBuilder
    • hasRegion

      public boolean hasRegion()
       Output only. [Output Only] URL of the region where the VPN gateway resides.
       
      optional string region = 138946292;
      Specified by:
      hasRegion in interface VpnGatewayOrBuilder
      Returns:
      Whether the region field is set.
    • getRegion

      public String getRegion()
       Output only. [Output Only] URL of the region where the VPN gateway resides.
       
      optional string region = 138946292;
      Specified by:
      getRegion in interface VpnGatewayOrBuilder
      Returns:
      The region.
    • getRegionBytes

      public com.google.protobuf.ByteString getRegionBytes()
       Output only. [Output Only] URL of the region where the VPN gateway resides.
       
      optional string region = 138946292;
      Specified by:
      getRegionBytes in interface VpnGatewayOrBuilder
      Returns:
      The bytes for region.
    • hasSelfLink

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

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

      public com.google.protobuf.ByteString getSelfLinkBytes()
       Output only. [Output Only] Server-defined URL for the resource.
       
      optional string self_link = 456214797;
      Specified by:
      getSelfLinkBytes in interface VpnGatewayOrBuilder
      Returns:
      The bytes for selfLink.
    • hasStackType

      public boolean hasStackType()
       The stack type for this VPN gateway to identify the IP protocols that are
       enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6.
       Check the StackType enum for the list of possible values.
       
      optional string stack_type = 425908881;
      Specified by:
      hasStackType in interface VpnGatewayOrBuilder
      Returns:
      Whether the stackType field is set.
    • getStackType

      public String getStackType()
       The stack type for this VPN gateway to identify the IP protocols that are
       enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6.
       Check the StackType enum for the list of possible values.
       
      optional string stack_type = 425908881;
      Specified by:
      getStackType in interface VpnGatewayOrBuilder
      Returns:
      The stackType.
    • getStackTypeBytes

      public com.google.protobuf.ByteString getStackTypeBytes()
       The stack type for this VPN gateway to identify the IP protocols that are
       enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6.
       Check the StackType enum for the list of possible values.
       
      optional string stack_type = 425908881;
      Specified by:
      getStackTypeBytes in interface VpnGatewayOrBuilder
      Returns:
      The bytes for stackType.
    • getVpnInterfacesList

      public List<VpnGatewayVpnGatewayInterface> getVpnInterfacesList()
       The list of VPN interfaces associated with this VPN gateway.
       
      repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
      Specified by:
      getVpnInterfacesList in interface VpnGatewayOrBuilder
    • getVpnInterfacesOrBuilderList

      public List<? extends VpnGatewayVpnGatewayInterfaceOrBuilder> getVpnInterfacesOrBuilderList()
       The list of VPN interfaces associated with this VPN gateway.
       
      repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
      Specified by:
      getVpnInterfacesOrBuilderList in interface VpnGatewayOrBuilder
    • getVpnInterfacesCount

      public int getVpnInterfacesCount()
       The list of VPN interfaces associated with this VPN gateway.
       
      repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
      Specified by:
      getVpnInterfacesCount in interface VpnGatewayOrBuilder
    • getVpnInterfaces

      public VpnGatewayVpnGatewayInterface getVpnInterfaces(int index)
       The list of VPN interfaces associated with this VPN gateway.
       
      repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
      Specified by:
      getVpnInterfaces in interface VpnGatewayOrBuilder
    • getVpnInterfacesOrBuilder

      public VpnGatewayVpnGatewayInterfaceOrBuilder getVpnInterfacesOrBuilder(int index)
       The list of VPN interfaces associated with this VPN gateway.
       
      repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
      Specified by:
      getVpnInterfacesOrBuilder in interface VpnGatewayOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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 VpnGateway parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static VpnGateway parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static VpnGateway parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static VpnGateway parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static VpnGateway parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static VpnGateway parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

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

      public static VpnGateway.Builder newBuilder()
    • newBuilder

      public static VpnGateway.Builder newBuilder(VpnGateway prototype)
    • toBuilder

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

      protected VpnGateway.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static VpnGateway getDefaultInstance()
    • parser

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

      public com.google.protobuf.Parser<VpnGateway> 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.GeneratedMessage
    • getDefaultInstanceForType

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