Class Address

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

    public final class Address
    extends com.google.protobuf.GeneratedMessageV3
    implements AddressOrBuilder
     Represents an IP Address resource. Google Compute Engine has two IP Address resources: * [Global (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses) * [Regional (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/addresses) For more information, see Reserving a static external IP address.
     
    Protobuf type google.cloud.compute.v1.Address
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Address.AddressType
      The type of address to reserve, either INTERNAL or EXTERNAL.
      static class  Address.Builder
      Represents an IP Address resource.
      static class  Address.Ipv6EndpointType
      The endpoint type of this address, which should be VM or NETLB.
      static class  Address.IpVersion
      The IP version that will be used by this address.
      static class  Address.NetworkTier
      This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD.
      static class  Address.Purpose
      The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
      static class  Address.Status
      [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
      • 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 Deprecated Methods 
      Modifier and Type Method Description
      boolean containsLabels​(String key)
      Labels for this resource.
      boolean equals​(Object obj)  
      String getAddress()
      The static IP address represented by this resource.
      com.google.protobuf.ByteString getAddressBytes()
      The static IP address represented by this resource.
      String getAddressType()
      The type of address to reserve, either INTERNAL or EXTERNAL.
      com.google.protobuf.ByteString getAddressTypeBytes()
      The type of address to reserve, either INTERNAL or EXTERNAL.
      String getCreationTimestamp()
      [Output Only] Creation timestamp in RFC3339 text format.
      com.google.protobuf.ByteString getCreationTimestampBytes()
      [Output Only] Creation timestamp in RFC3339 text format.
      static Address getDefaultInstance()  
      Address getDefaultInstanceForType()  
      String getDescription()
      An optional description of this resource.
      com.google.protobuf.ByteString getDescriptionBytes()
      An optional description of this resource.
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      long getId()
      [Output Only] The unique identifier for the resource.
      String getIpv6EndpointType()
      The endpoint type of this address, which should be VM or NETLB.
      com.google.protobuf.ByteString getIpv6EndpointTypeBytes()
      The endpoint type of this address, which should be VM or NETLB.
      String getIpVersion()
      The IP version that will be used by this address.
      com.google.protobuf.ByteString getIpVersionBytes()
      The IP version that will be used by this address.
      String getKind()
      [Output Only] Type of the resource.
      com.google.protobuf.ByteString getKindBytes()
      [Output Only] Type of the resource.
      String getLabelFingerprint()
      A fingerprint for the labels being applied to this Address, 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 Address, 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()
      The URL of the network in which to reserve the address.
      com.google.protobuf.ByteString getNetworkBytes()
      The URL of the network in which to reserve the address.
      String getNetworkTier()
      This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD.
      com.google.protobuf.ByteString getNetworkTierBytes()
      This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD.
      com.google.protobuf.Parser<Address> getParserForType()  
      int getPrefixLength()
      The prefix length if the resource represents an IP range.
      String getPurpose()
      The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
      com.google.protobuf.ByteString getPurposeBytes()
      The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
      String getRegion()
      [Output Only] The URL of the region where a regional address resides.
      com.google.protobuf.ByteString getRegionBytes()
      [Output Only] The URL of the region where a regional address resides.
      String getSelfLink()
      [Output Only] Server-defined URL for the resource.
      com.google.protobuf.ByteString getSelfLinkBytes()
      [Output Only] Server-defined URL for the resource.
      int getSerializedSize()  
      String getStatus()
      [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
      com.google.protobuf.ByteString getStatusBytes()
      [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
      String getSubnetwork()
      The URL of the subnetwork in which to reserve the address.
      com.google.protobuf.ByteString getSubnetworkBytes()
      The URL of the subnetwork in which to reserve the address.
      String getUsers​(int index)
      [Output Only] The URLs of the resources that are using this address.
      com.google.protobuf.ByteString getUsersBytes​(int index)
      [Output Only] The URLs of the resources that are using this address.
      int getUsersCount()
      [Output Only] The URLs of the resources that are using this address.
      com.google.protobuf.ProtocolStringList getUsersList()
      [Output Only] The URLs of the resources that are using this address.
      boolean hasAddress()
      The static IP address represented by this resource.
      boolean hasAddressType()
      The type of address to reserve, either INTERNAL or EXTERNAL.
      boolean hasCreationTimestamp()
      [Output Only] Creation timestamp in RFC3339 text format.
      boolean hasDescription()
      An optional description of this resource.
      int hashCode()  
      boolean hasId()
      [Output Only] The unique identifier for the resource.
      boolean hasIpv6EndpointType()
      The endpoint type of this address, which should be VM or NETLB.
      boolean hasIpVersion()
      The IP version that will be used by this address.
      boolean hasKind()
      [Output Only] Type of the resource.
      boolean hasLabelFingerprint()
      A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking.
      boolean hasName()
      Name of the resource.
      boolean hasNetwork()
      The URL of the network in which to reserve the address.
      boolean hasNetworkTier()
      This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD.
      boolean hasPrefixLength()
      The prefix length if the resource represents an IP range.
      boolean hasPurpose()
      The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
      boolean hasRegion()
      [Output Only] The URL of the region where a regional address resides.
      boolean hasSelfLink()
      [Output Only] Server-defined URL for the resource.
      boolean hasStatus()
      [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
      boolean hasSubnetwork()
      The URL of the subnetwork in which to reserve the address.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      boolean isInitialized()  
      static Address.Builder newBuilder()  
      static Address.Builder newBuilder​(Address prototype)  
      Address.Builder newBuilderForType()  
      protected Address.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Address parseDelimitedFrom​(InputStream input)  
      static Address parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Address parseFrom​(byte[] data)  
      static Address parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Address parseFrom​(com.google.protobuf.ByteString data)  
      static Address parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Address parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Address parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Address parseFrom​(InputStream input)  
      static Address parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Address parseFrom​(ByteBuffer data)  
      static Address parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Address> parser()  
      Address.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, 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()
      • 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
      • hasAddress

        public boolean hasAddress()
         The static IP address represented by this resource.
         
        optional string address = 462920692;
        Specified by:
        hasAddress in interface AddressOrBuilder
        Returns:
        Whether the address field is set.
      • getAddress

        public String getAddress()
         The static IP address represented by this resource.
         
        optional string address = 462920692;
        Specified by:
        getAddress in interface AddressOrBuilder
        Returns:
        The address.
      • getAddressBytes

        public com.google.protobuf.ByteString getAddressBytes()
         The static IP address represented by this resource.
         
        optional string address = 462920692;
        Specified by:
        getAddressBytes in interface AddressOrBuilder
        Returns:
        The bytes for address.
      • hasAddressType

        public boolean hasAddressType()
         The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
         Check the AddressType enum for the list of possible values.
         
        optional string address_type = 264307877;
        Specified by:
        hasAddressType in interface AddressOrBuilder
        Returns:
        Whether the addressType field is set.
      • getAddressType

        public String getAddressType()
         The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
         Check the AddressType enum for the list of possible values.
         
        optional string address_type = 264307877;
        Specified by:
        getAddressType in interface AddressOrBuilder
        Returns:
        The addressType.
      • getAddressTypeBytes

        public com.google.protobuf.ByteString getAddressTypeBytes()
         The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
         Check the AddressType enum for the list of possible values.
         
        optional string address_type = 264307877;
        Specified by:
        getAddressTypeBytes in interface AddressOrBuilder
        Returns:
        The bytes for addressType.
      • hasCreationTimestamp

        public boolean hasCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        hasCreationTimestamp in interface AddressOrBuilder
        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 AddressOrBuilder
        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 AddressOrBuilder
        Returns:
        The bytes for creationTimestamp.
      • hasDescription

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

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

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

        public boolean hasId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
         
        optional uint64 id = 3355;
        Specified by:
        hasId in interface AddressOrBuilder
        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 AddressOrBuilder
        Returns:
        The id.
      • hasIpVersion

        public boolean hasIpVersion()
         The IP version that will be used by this address. Valid options are IPV4 or IPV6.
         Check the IpVersion enum for the list of possible values.
         
        optional string ip_version = 294959552;
        Specified by:
        hasIpVersion in interface AddressOrBuilder
        Returns:
        Whether the ipVersion field is set.
      • getIpVersion

        public String getIpVersion()
         The IP version that will be used by this address. Valid options are IPV4 or IPV6.
         Check the IpVersion enum for the list of possible values.
         
        optional string ip_version = 294959552;
        Specified by:
        getIpVersion in interface AddressOrBuilder
        Returns:
        The ipVersion.
      • getIpVersionBytes

        public com.google.protobuf.ByteString getIpVersionBytes()
         The IP version that will be used by this address. Valid options are IPV4 or IPV6.
         Check the IpVersion enum for the list of possible values.
         
        optional string ip_version = 294959552;
        Specified by:
        getIpVersionBytes in interface AddressOrBuilder
        Returns:
        The bytes for ipVersion.
      • hasIpv6EndpointType

        public boolean hasIpv6EndpointType()
         The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
         Check the Ipv6EndpointType enum for the list of possible values.
         
        optional string ipv6_endpoint_type = 97501004;
        Specified by:
        hasIpv6EndpointType in interface AddressOrBuilder
        Returns:
        Whether the ipv6EndpointType field is set.
      • getIpv6EndpointType

        public String getIpv6EndpointType()
         The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
         Check the Ipv6EndpointType enum for the list of possible values.
         
        optional string ipv6_endpoint_type = 97501004;
        Specified by:
        getIpv6EndpointType in interface AddressOrBuilder
        Returns:
        The ipv6EndpointType.
      • getIpv6EndpointTypeBytes

        public com.google.protobuf.ByteString getIpv6EndpointTypeBytes()
         The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
         Check the Ipv6EndpointType enum for the list of possible values.
         
        optional string ipv6_endpoint_type = 97501004;
        Specified by:
        getIpv6EndpointTypeBytes in interface AddressOrBuilder
        Returns:
        The bytes for ipv6EndpointType.
      • hasKind

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

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

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

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

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

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

        public int getLabelsCount()
        Description copied from interface: AddressOrBuilder
         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 AddressOrBuilder
      • 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 AddressOrBuilder
      • 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 AddressOrBuilder
      • 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 AddressOrBuilder
      • 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 AddressOrBuilder
      • 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
         
        optional string name = 3373707;
        Specified by:
        hasName in interface AddressOrBuilder
        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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
         
        optional string name = 3373707;
        Specified by:
        getName in interface AddressOrBuilder
        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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
         
        optional string name = 3373707;
        Specified by:
        getNameBytes in interface AddressOrBuilder
        Returns:
        The bytes for name.
      • hasNetwork

        public boolean hasNetwork()
         The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
         
        optional string network = 232872494;
        Specified by:
        hasNetwork in interface AddressOrBuilder
        Returns:
        Whether the network field is set.
      • getNetwork

        public String getNetwork()
         The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
         
        optional string network = 232872494;
        Specified by:
        getNetwork in interface AddressOrBuilder
        Returns:
        The network.
      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
         
        optional string network = 232872494;
        Specified by:
        getNetworkBytes in interface AddressOrBuilder
        Returns:
        The bytes for network.
      • hasNetworkTier

        public boolean hasNetworkTier()
         This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
         Check the NetworkTier enum for the list of possible values.
         
        optional string network_tier = 517397843;
        Specified by:
        hasNetworkTier in interface AddressOrBuilder
        Returns:
        Whether the networkTier field is set.
      • getNetworkTier

        public String getNetworkTier()
         This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
         Check the NetworkTier enum for the list of possible values.
         
        optional string network_tier = 517397843;
        Specified by:
        getNetworkTier in interface AddressOrBuilder
        Returns:
        The networkTier.
      • getNetworkTierBytes

        public com.google.protobuf.ByteString getNetworkTierBytes()
         This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
         Check the NetworkTier enum for the list of possible values.
         
        optional string network_tier = 517397843;
        Specified by:
        getNetworkTierBytes in interface AddressOrBuilder
        Returns:
        The bytes for networkTier.
      • hasPrefixLength

        public boolean hasPrefixLength()
         The prefix length if the resource represents an IP range.
         
        optional int32 prefix_length = 453565747;
        Specified by:
        hasPrefixLength in interface AddressOrBuilder
        Returns:
        Whether the prefixLength field is set.
      • getPrefixLength

        public int getPrefixLength()
         The prefix length if the resource represents an IP range.
         
        optional int32 prefix_length = 453565747;
        Specified by:
        getPrefixLength in interface AddressOrBuilder
        Returns:
        The prefixLength.
      • hasPurpose

        public boolean hasPurpose()
         The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
         Check the Purpose enum for the list of possible values.
         
        optional string purpose = 316407070;
        Specified by:
        hasPurpose in interface AddressOrBuilder
        Returns:
        Whether the purpose field is set.
      • getPurpose

        public String getPurpose()
         The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
         Check the Purpose enum for the list of possible values.
         
        optional string purpose = 316407070;
        Specified by:
        getPurpose in interface AddressOrBuilder
        Returns:
        The purpose.
      • getPurposeBytes

        public com.google.protobuf.ByteString getPurposeBytes()
         The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
         Check the Purpose enum for the list of possible values.
         
        optional string purpose = 316407070;
        Specified by:
        getPurposeBytes in interface AddressOrBuilder
        Returns:
        The bytes for purpose.
      • hasRegion

        public boolean hasRegion()
         [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*
         
        optional string region = 138946292;
        Specified by:
        hasRegion in interface AddressOrBuilder
        Returns:
        Whether the region field is set.
      • getRegion

        public String getRegion()
         [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*
         
        optional string region = 138946292;
        Specified by:
        getRegion in interface AddressOrBuilder
        Returns:
        The region.
      • getRegionBytes

        public com.google.protobuf.ByteString getRegionBytes()
         [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*
         
        optional string region = 138946292;
        Specified by:
        getRegionBytes in interface AddressOrBuilder
        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 AddressOrBuilder
        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 AddressOrBuilder
        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 AddressOrBuilder
        Returns:
        The bytes for selfLink.
      • hasStatus

        public boolean hasStatus()
         [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
         Check the Status enum for the list of possible values.
         
        optional string status = 181260274;
        Specified by:
        hasStatus in interface AddressOrBuilder
        Returns:
        Whether the status field is set.
      • getStatus

        public String getStatus()
         [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
         Check the Status enum for the list of possible values.
         
        optional string status = 181260274;
        Specified by:
        getStatus in interface AddressOrBuilder
        Returns:
        The status.
      • getStatusBytes

        public com.google.protobuf.ByteString getStatusBytes()
         [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
         Check the Status enum for the list of possible values.
         
        optional string status = 181260274;
        Specified by:
        getStatusBytes in interface AddressOrBuilder
        Returns:
        The bytes for status.
      • hasSubnetwork

        public boolean hasSubnetwork()
         The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
         
        optional string subnetwork = 307827694;
        Specified by:
        hasSubnetwork in interface AddressOrBuilder
        Returns:
        Whether the subnetwork field is set.
      • getSubnetwork

        public String getSubnetwork()
         The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
         
        optional string subnetwork = 307827694;
        Specified by:
        getSubnetwork in interface AddressOrBuilder
        Returns:
        The subnetwork.
      • getSubnetworkBytes

        public com.google.protobuf.ByteString getSubnetworkBytes()
         The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
         
        optional string subnetwork = 307827694;
        Specified by:
        getSubnetworkBytes in interface AddressOrBuilder
        Returns:
        The bytes for subnetwork.
      • getUsersList

        public com.google.protobuf.ProtocolStringList getUsersList()
         [Output Only] The URLs of the resources that are using this address.
         
        repeated string users = 111578632;
        Specified by:
        getUsersList in interface AddressOrBuilder
        Returns:
        A list containing the users.
      • getUsersCount

        public int getUsersCount()
         [Output Only] The URLs of the resources that are using this address.
         
        repeated string users = 111578632;
        Specified by:
        getUsersCount in interface AddressOrBuilder
        Returns:
        The count of users.
      • getUsers

        public String getUsers​(int index)
         [Output Only] The URLs of the resources that are using this address.
         
        repeated string users = 111578632;
        Specified by:
        getUsers in interface AddressOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The users at the given index.
      • getUsersBytes

        public com.google.protobuf.ByteString getUsersBytes​(int index)
         [Output Only] The URLs of the resources that are using this address.
         
        repeated string users = 111578632;
        Specified by:
        getUsersBytes in interface AddressOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the users 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 Address parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static Address getDefaultInstance()
      • parser

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

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