Package com.google.cloud.compute.v1

Class AccessConfig

  • All Implemented Interfaces:
    AccessConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AccessConfig
extends com.google.protobuf.GeneratedMessageV3
implements AccessConfigOrBuilder
     An access configuration attached to an instance's network interface. Only one access config per instance is supported.
    Protobuf type google.cloud.compute.v1.AccessConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AccessConfig.Builder
      An access configuration attached to an instance's network interface.
      static class  AccessConfig.NetworkTier
      This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
      static class  AccessConfig.Type
      The type of configuration.

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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static AccessConfig getDefaultInstance()  
      AccessConfig getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      String getExternalIpv6()
      Applies to ipv6AccessConfigs only.
      com.google.protobuf.ByteString getExternalIpv6Bytes()
      Applies to ipv6AccessConfigs only.
      int getExternalIpv6PrefixLength()
      Applies to ipv6AccessConfigs only.
      String getKind()
      [Output Only] Type of the resource.
      com.google.protobuf.ByteString getKindBytes()
      [Output Only] Type of the resource.
      String getName()
      The name of this access configuration.
      com.google.protobuf.ByteString getNameBytes()
      The name of this access configuration.
      String getNatIP()
      Applies to accessConfigs (IPv4) only.
      com.google.protobuf.ByteString getNatIPBytes()
      Applies to accessConfigs (IPv4) only.
      String getNetworkTier()
      This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
      com.google.protobuf.ByteString getNetworkTierBytes()
      This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
      com.google.protobuf.Parser<AccessConfig> getParserForType()  
      String getPublicPtrDomainName()
      The DNS domain name for the public PTR record.
      com.google.protobuf.ByteString getPublicPtrDomainNameBytes()
      The DNS domain name for the public PTR record.
      int getSerializedSize()  
      boolean getSetPublicPtr()
      Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
      String getType()
      The type of configuration.
      com.google.protobuf.ByteString getTypeBytes()
      The type of configuration.
      boolean hasExternalIpv6()
      Applies to ipv6AccessConfigs only.
      boolean hasExternalIpv6PrefixLength()
      Applies to ipv6AccessConfigs only.
      int hashCode()  
      boolean hasKind()
      [Output Only] Type of the resource.
      boolean hasName()
      The name of this access configuration.
      boolean hasNatIP()
      Applies to accessConfigs (IPv4) only.
      boolean hasNetworkTier()
      This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
      boolean hasPublicPtrDomainName()
      The DNS domain name for the public PTR record.
      boolean hasSetPublicPtr()
      Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
      boolean hasType()
      The type of configuration.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static AccessConfig.Builder newBuilder()  
      static AccessConfig.Builder newBuilder​(AccessConfig prototype)  
      AccessConfig.Builder newBuilderForType()  
      protected AccessConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static AccessConfig parseDelimitedFrom​(InputStream input)  
      static AccessConfig parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AccessConfig parseFrom​(byte[] data)  
      static AccessConfig parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AccessConfig parseFrom​(com.google.protobuf.ByteString data)  
      static AccessConfig parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AccessConfig parseFrom​(com.google.protobuf.CodedInputStream input)  
      static AccessConfig parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AccessConfig parseFrom​(InputStream input)  
      static AccessConfig parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AccessConfig parseFrom​(ByteBuffer data)  
      static AccessConfig parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<AccessConfig> parser()  
      AccessConfig.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

    • Method Detail

      • newInstance

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

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • hasExternalIpv6

        public boolean hasExternalIpv6()
         Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.
        optional string external_ipv6 = 532703707;
        Specified by:
        hasExternalIpv6 in interface AccessConfigOrBuilder
        Returns:
        Whether the externalIpv6 field is set.

      • getExternalIpv6

        public String getExternalIpv6()
         Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.
        optional string external_ipv6 = 532703707;
        Specified by:
        getExternalIpv6 in interface AccessConfigOrBuilder
        Returns:
        The externalIpv6.

      • getExternalIpv6Bytes

        public com.google.protobuf.ByteString getExternalIpv6Bytes()
         Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.
        optional string external_ipv6 = 532703707;
        Specified by:
        getExternalIpv6Bytes in interface AccessConfigOrBuilder
        Returns:
        The bytes for externalIpv6.

      • hasExternalIpv6PrefixLength

        public boolean hasExternalIpv6PrefixLength()
         Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.
        optional int32 external_ipv6_prefix_length = 425672143;
        Specified by:
        hasExternalIpv6PrefixLength in interface AccessConfigOrBuilder
        Returns:
        Whether the externalIpv6PrefixLength field is set.

      • getExternalIpv6PrefixLength

        public int getExternalIpv6PrefixLength()
         Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.
        optional int32 external_ipv6_prefix_length = 425672143;
        Specified by:
        getExternalIpv6PrefixLength in interface AccessConfigOrBuilder
        Returns:
        The externalIpv6PrefixLength.

      • hasKind

        public boolean hasKind()
         [Output Only] Type of the resource. Always compute#accessConfig for access configs.
        optional string kind = 3292052;
        Specified by:
        hasKind in interface AccessConfigOrBuilder
        Returns:
        Whether the kind field is set.

      • getKind

        public String getKind()
         [Output Only] Type of the resource. Always compute#accessConfig for access configs.
        optional string kind = 3292052;
        Specified by:
        getKind in interface AccessConfigOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output Only] Type of the resource. Always compute#accessConfig for access configs.
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface AccessConfigOrBuilder
        Returns:
        The bytes for kind.

      • hasName

        public boolean hasName()
         The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.
        optional string name = 3373707;
        Specified by:
        hasName in interface AccessConfigOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public String getName()
         The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.
        optional string name = 3373707;
        Specified by:
        getName in interface AccessConfigOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.
        optional string name = 3373707;
        Specified by:
        getNameBytes in interface AccessConfigOrBuilder
        Returns:
        The bytes for name.

      • hasNatIP

        public boolean hasNatIP()
         Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
        optional string nat_i_p = 117634556;
        Specified by:
        hasNatIP in interface AccessConfigOrBuilder
        Returns:
        Whether the natIP field is set.

      • getNatIP

        public String getNatIP()
         Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
        optional string nat_i_p = 117634556;
        Specified by:
        getNatIP in interface AccessConfigOrBuilder
        Returns:
        The natIP.

      • getNatIPBytes

        public com.google.protobuf.ByteString getNatIPBytes()
         Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
        optional string nat_i_p = 117634556;
        Specified by:
        getNatIPBytes in interface AccessConfigOrBuilder
        Returns:
        The bytes for natIP.

      • hasNetworkTier

        public boolean hasNetworkTier()
         This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
 Check the NetworkTier enum for the list of possible values.
        optional string network_tier = 517397843;
        Specified by:
        hasNetworkTier in interface AccessConfigOrBuilder
        Returns:
        Whether the networkTier field is set.

      • getNetworkTier

        public String getNetworkTier()
         This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
 Check the NetworkTier enum for the list of possible values.
        optional string network_tier = 517397843;
        Specified by:
        getNetworkTier in interface AccessConfigOrBuilder
        Returns:
        The networkTier.

      • getNetworkTierBytes

        public com.google.protobuf.ByteString getNetworkTierBytes()
         This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
 Check the NetworkTier enum for the list of possible values.
        optional string network_tier = 517397843;
        Specified by:
        getNetworkTierBytes in interface AccessConfigOrBuilder
        Returns:
        The bytes for networkTier.

      • hasPublicPtrDomainName

        public boolean hasPublicPtrDomainName()
         The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.
        optional string public_ptr_domain_name = 316599167;
        Specified by:
        hasPublicPtrDomainName in interface AccessConfigOrBuilder
        Returns:
        Whether the publicPtrDomainName field is set.

      • getPublicPtrDomainName

        public String getPublicPtrDomainName()
         The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.
        optional string public_ptr_domain_name = 316599167;
        Specified by:
        getPublicPtrDomainName in interface AccessConfigOrBuilder
        Returns:
        The publicPtrDomainName.

      • getPublicPtrDomainNameBytes

        public com.google.protobuf.ByteString getPublicPtrDomainNameBytes()
         The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.
        optional string public_ptr_domain_name = 316599167;
        Specified by:
        getPublicPtrDomainNameBytes in interface AccessConfigOrBuilder
        Returns:
        The bytes for publicPtrDomainName.

      • hasSetPublicPtr

        public boolean hasSetPublicPtr()
         Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.
        optional bool set_public_ptr = 523870229;
        Specified by:
        hasSetPublicPtr in interface AccessConfigOrBuilder
        Returns:
        Whether the setPublicPtr field is set.

      • getSetPublicPtr

        public boolean getSetPublicPtr()
         Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.
        optional bool set_public_ptr = 523870229;
        Specified by:
        getSetPublicPtr in interface AccessConfigOrBuilder
        Returns:
        The setPublicPtr.

      • hasType

        public boolean hasType()
         The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
 Check the Type enum for the list of possible values.
        optional string type = 3575610;
        Specified by:
        hasType in interface AccessConfigOrBuilder
        Returns:
        Whether the type field is set.

      • getType

        public String getType()
         The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
 Check the Type enum for the list of possible values.
        optional string type = 3575610;
        Specified by:
        getType in interface AccessConfigOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
 Check the Type enum for the list of possible values.
        optional string type = 3575610;
        Specified by:
        getTypeBytes in interface AccessConfigOrBuilder
        Returns:
        The bytes for type.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static AccessConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<AccessConfig> parser()

      • getParserForType

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