Package com.google.cloud.compute.v1

Class NetworkEndpointGroup

  • All Implemented Interfaces:
    NetworkEndpointGroupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class NetworkEndpointGroup
extends com.google.protobuf.GeneratedMessageV3
implements NetworkEndpointGroupOrBuilder
     Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs.
    Protobuf type google.cloud.compute.v1.NetworkEndpointGroup
    See Also:
    Serialized Form

    • 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

      • hasAppEngine

        public boolean hasAppEngine()
         Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
        optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768;
        Specified by:
        hasAppEngine in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the appEngine field is set.

      • getAppEngine

        public NetworkEndpointGroupAppEngine getAppEngine()
         Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
        optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768;
        Specified by:
        getAppEngine in interface NetworkEndpointGroupOrBuilder
        Returns:
        The appEngine.

      • hasCloudFunction

        public boolean hasCloudFunction()
         Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
        optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666;
        Specified by:
        hasCloudFunction in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the cloudFunction field is set.

      • getCloudFunction

        public NetworkEndpointGroupCloudFunction getCloudFunction()
         Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
        optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666;
        Specified by:
        getCloudFunction in interface NetworkEndpointGroupOrBuilder
        Returns:
        The cloudFunction.

      • hasCloudRun

        public boolean hasCloudRun()
         Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
        optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353;
        Specified by:
        hasCloudRun in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the cloudRun field is set.

      • getCloudRun

        public NetworkEndpointGroupCloudRun getCloudRun()
         Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
        optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353;
        Specified by:
        getCloudRun in interface NetworkEndpointGroupOrBuilder
        Returns:
        The cloudRun.

      • hasCreationTimestamp

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

      • hasDefaultPort

        public boolean hasDefaultPort()
         The default port used if the port number is not specified in the network endpoint.
        optional int32 default_port = 423377855;
        Specified by:
        hasDefaultPort in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the defaultPort field is set.

      • getDefaultPort

        public int getDefaultPort()
         The default port used if the port number is not specified in the network endpoint.
        optional int32 default_port = 423377855;
        Specified by:
        getDefaultPort in interface NetworkEndpointGroupOrBuilder
        Returns:
        The defaultPort.

      • hasDescription

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

      • getDescription

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

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Specified by:
        getDescriptionBytes in interface NetworkEndpointGroupOrBuilder
        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 NetworkEndpointGroupOrBuilder
        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 NetworkEndpointGroupOrBuilder
        Returns:
        The id.

      • hasKind

        public boolean hasKind()
         [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
        optional string kind = 3292052;
        Specified by:
        hasKind in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the kind field is set.

      • getKind

        public String getKind()
         [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
        optional string kind = 3292052;
        Specified by:
        getKind in interface NetworkEndpointGroupOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface NetworkEndpointGroupOrBuilder
        Returns:
        The bytes for kind.

      • hasName

        public boolean hasName()
         Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string name = 3373707;
        Specified by:
        hasName in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public String getName()
         Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string name = 3373707;
        Specified by:
        getName in interface NetworkEndpointGroupOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string name = 3373707;
        Specified by:
        getNameBytes in interface NetworkEndpointGroupOrBuilder
        Returns:
        The bytes for name.

      • hasNetwork

        public boolean hasNetwork()
         The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
        optional string network = 232872494;
        Specified by:
        hasNetwork in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the network field is set.

      • getNetwork

        public String getNetwork()
         The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
        optional string network = 232872494;
        Specified by:
        getNetwork in interface NetworkEndpointGroupOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
        optional string network = 232872494;
        Specified by:
        getNetworkBytes in interface NetworkEndpointGroupOrBuilder
        Returns:
        The bytes for network.

      • hasNetworkEndpointType

        public boolean hasNetworkEndpointType()
         Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT.
 Check the NetworkEndpointType enum for the list of possible values.
        optional string network_endpoint_type = 118301523;
        Specified by:
        hasNetworkEndpointType in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the networkEndpointType field is set.

      • getNetworkEndpointType

        public String getNetworkEndpointType()
         Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT.
 Check the NetworkEndpointType enum for the list of possible values.
        optional string network_endpoint_type = 118301523;
        Specified by:
        getNetworkEndpointType in interface NetworkEndpointGroupOrBuilder
        Returns:
        The networkEndpointType.

      • getNetworkEndpointTypeBytes

        public com.google.protobuf.ByteString getNetworkEndpointTypeBytes()
         Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT.
 Check the NetworkEndpointType enum for the list of possible values.
        optional string network_endpoint_type = 118301523;
        Specified by:
        getNetworkEndpointTypeBytes in interface NetworkEndpointGroupOrBuilder
        Returns:
        The bytes for networkEndpointType.

      • hasPscData

        public boolean hasPscData()
        optional .google.cloud.compute.v1.NetworkEndpointGroupPscData psc_data = 71937481;
        Specified by:
        hasPscData in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the pscData field is set.

      • hasPscTargetService

        public boolean hasPscTargetService()
         The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com"
        optional string psc_target_service = 269132134;
        Specified by:
        hasPscTargetService in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the pscTargetService field is set.

      • getPscTargetService

        public String getPscTargetService()
         The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com"
        optional string psc_target_service = 269132134;
        Specified by:
        getPscTargetService in interface NetworkEndpointGroupOrBuilder
        Returns:
        The pscTargetService.

      • getPscTargetServiceBytes

        public com.google.protobuf.ByteString getPscTargetServiceBytes()
         The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com"
        optional string psc_target_service = 269132134;
        Specified by:
        getPscTargetServiceBytes in interface NetworkEndpointGroupOrBuilder
        Returns:
        The bytes for pscTargetService.

      • hasRegion

        public boolean hasRegion()
         [Output Only] The URL of the region where the network endpoint group is located.
        optional string region = 138946292;
        Specified by:
        hasRegion in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the region field is set.

      • getRegion

        public String getRegion()
         [Output Only] The URL of the region where the network endpoint group is located.
        optional string region = 138946292;
        Specified by:
        getRegion in interface NetworkEndpointGroupOrBuilder
        Returns:
        The region.

      • getRegionBytes

        public com.google.protobuf.ByteString getRegionBytes()
         [Output Only] The URL of the region where the network endpoint group is located.
        optional string region = 138946292;
        Specified by:
        getRegionBytes in interface NetworkEndpointGroupOrBuilder
        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 NetworkEndpointGroupOrBuilder
        Returns:
        Whether the selfLink field is set.

      • 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 NetworkEndpointGroupOrBuilder
        Returns:
        The bytes for selfLink.

      • hasSize

        public boolean hasSize()
         [Output only] Number of network endpoints in the network endpoint group.
        optional int32 size = 3530753;
        Specified by:
        hasSize in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the size field is set.

      • getSize

        public int getSize()
         [Output only] Number of network endpoints in the network endpoint group.
        optional int32 size = 3530753;
        Specified by:
        getSize in interface NetworkEndpointGroupOrBuilder
        Returns:
        The size.

      • hasSubnetwork

        public boolean hasSubnetwork()
         Optional URL of the subnetwork to which all network endpoints in the NEG belong.
        optional string subnetwork = 307827694;
        Specified by:
        hasSubnetwork in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the subnetwork field is set.

      • getSubnetwork

        public String getSubnetwork()
         Optional URL of the subnetwork to which all network endpoints in the NEG belong.
        optional string subnetwork = 307827694;
        Specified by:
        getSubnetwork in interface NetworkEndpointGroupOrBuilder
        Returns:
        The subnetwork.

      • getSubnetworkBytes

        public com.google.protobuf.ByteString getSubnetworkBytes()
         Optional URL of the subnetwork to which all network endpoints in the NEG belong.
        optional string subnetwork = 307827694;
        Specified by:
        getSubnetworkBytes in interface NetworkEndpointGroupOrBuilder
        Returns:
        The bytes for subnetwork.

      • hasZone

        public boolean hasZone()
         [Output Only] The URL of the zone where the network endpoint group is located.
        optional string zone = 3744684;
        Specified by:
        hasZone in interface NetworkEndpointGroupOrBuilder
        Returns:
        Whether the zone field is set.

      • getZone

        public String getZone()
         [Output Only] The URL of the zone where the network endpoint group is located.
        optional string zone = 3744684;
        Specified by:
        getZone in interface NetworkEndpointGroupOrBuilder
        Returns:
        The zone.

      • getZoneBytes

        public com.google.protobuf.ByteString getZoneBytes()
         [Output Only] The URL of the zone where the network endpoint group is located.
        optional string zone = 3744684;
        Specified by:
        getZoneBytes in interface NetworkEndpointGroupOrBuilder
        Returns:
        The bytes for zone.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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