Package com.google.cloud.compute.v1

Interface TargetVpnGatewayOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TargetVpnGateway, TargetVpnGateway.Builder
    public interface TargetVpnGatewayOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsLabels​(String key)
      Labels for this resource.
      String getCreationTimestamp()
      [Output Only] Creation timestamp in RFC3339 text format.
      com.google.protobuf.ByteString getCreationTimestampBytes()
      [Output Only] Creation timestamp in RFC3339 text format.
      String getDescription()
      An optional description of this resource.
      com.google.protobuf.ByteString getDescriptionBytes()
      An optional description of this resource.
      String getForwardingRules​(int index)
      [Output Only] A list of URLs to the ForwardingRule resources.
      com.google.protobuf.ByteString getForwardingRulesBytes​(int index)
      [Output Only] A list of URLs to the ForwardingRule resources.
      int getForwardingRulesCount()
      [Output Only] A list of URLs to the ForwardingRule resources.
      List<String> getForwardingRulesList()
      [Output Only] A list of URLs to the ForwardingRule resources.
      long getId()
      [Output Only] The unique identifier for the resource.
      String getKind()
      [Output Only] Type of resource.
      com.google.protobuf.ByteString getKindBytes()
      [Output Only] Type of resource.
      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.
      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.
      Map<String,​String> getLabels()
      Deprecated.
      int getLabelsCount()
      Labels for this resource.
      Map<String,​String> getLabelsMap()
      Labels for this resource.
      String getLabelsOrDefault​(String key, String defaultValue)
      Labels for this resource.
      String getLabelsOrThrow​(String key)
      Labels for this resource.
      String getName()
      Name of the resource.
      com.google.protobuf.ByteString getNameBytes()
      Name of the resource.
      String getNetwork()
      URL of the network to which this VPN gateway is attached.
      com.google.protobuf.ByteString getNetworkBytes()
      URL of the network to which this VPN gateway is attached.
      String getRegion()
      [Output Only] URL of the region where the target VPN gateway resides.
      com.google.protobuf.ByteString getRegionBytes()
      [Output Only] URL of the region where the target VPN gateway resides.
      String getSelfLink()
      [Output Only] Server-defined URL for the resource.
      com.google.protobuf.ByteString getSelfLinkBytes()
      [Output Only] Server-defined URL for the resource.
      String getStatus()
      [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
      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.
      String getTunnels​(int index)
      [Output Only] A list of URLs to VpnTunnel resources.
      com.google.protobuf.ByteString getTunnelsBytes​(int index)
      [Output Only] A list of URLs to VpnTunnel resources.
      int getTunnelsCount()
      [Output Only] A list of URLs to VpnTunnel resources.
      List<String> getTunnelsList()
      [Output Only] A list of URLs to VpnTunnel resources.
      boolean hasCreationTimestamp()
      [Output Only] Creation timestamp in RFC3339 text format.
      boolean hasDescription()
      An optional description of this resource.
      boolean hasId()
      [Output Only] The unique identifier for the resource.
      boolean hasKind()
      [Output Only] Type of resource.
      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.
      boolean hasName()
      Name of the resource.
      boolean hasNetwork()
      URL of the network to which this VPN gateway is attached.
      boolean hasRegion()
      [Output Only] URL of the region where the target VPN gateway resides.
      boolean hasSelfLink()
      [Output Only] Server-defined URL for the resource.
      boolean hasStatus()
      [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasCreationTimestamp

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

      • getCreationTimestamp

        String getCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
        optional string creation_timestamp = 30525366;
        Returns:
        The creationTimestamp.

      • getCreationTimestampBytes

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

      • hasDescription

        boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        Whether the description field is set.

      • getDescription

        String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        The bytes for description.

      • getForwardingRulesList

        List<String> 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;
        Returns:
        A list containing the forwardingRules.

      • getForwardingRulesCount

        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;
        Returns:
        The count of forwardingRules.

      • getForwardingRules

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The forwardingRules at the given index.

      • getForwardingRulesBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the forwardingRules at the given index.

      • hasId

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

      • getId

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

      • hasKind

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

      • getKind

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

      • getKindBytes

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

      • hasLabelFingerprint

        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;
        Returns:
        Whether the labelFingerprint field is set.

      • getLabelFingerprint

        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;
        Returns:
        The labelFingerprint.

      • getLabelFingerprintBytes

        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;
        Returns:
        The bytes for labelFingerprint.

      • getLabelsCount

        int getLabelsCount()
         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;

      • containsLabels

        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;

      • getLabelsMap

        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;

      • getLabelsOrDefault

        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;

      • getLabelsOrThrow

        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;

      • hasName

        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;
        Returns:
        Whether the name field is set.

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

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

      • hasNetwork

        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;
        Returns:
        Whether the network field is set.

      • getNetwork

        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;
        Returns:
        The network.

      • getNetworkBytes

        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;
        Returns:
        The bytes for network.

      • hasRegion

        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;
        Returns:
        Whether the region field is set.

      • getRegion

        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;
        Returns:
        The region.

      • getRegionBytes

        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;
        Returns:
        The bytes for region.

      • hasSelfLink

        boolean hasSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Returns:
        Whether the selfLink field is set.

      • getSelfLink

        String getSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Returns:
        The selfLink.

      • getSelfLinkBytes

        com.google.protobuf.ByteString getSelfLinkBytes()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Returns:
        The bytes for selfLink.

      • hasStatus

        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;
        Returns:
        Whether the status field is set.

      • getStatus

        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;
        Returns:
        The status.

      • getStatusBytes

        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;
        Returns:
        The bytes for status.

      • getTunnelsList

        List<String> 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;
        Returns:
        A list containing the tunnels.

      • getTunnelsCount

        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;
        Returns:
        The count of tunnels.

      • getTunnels

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The tunnels at the given index.

      • getTunnelsBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the tunnels at the given index.