Package com.google.cloud.networkmanagement.v1

Class Endpoint

  • All Implemented Interfaces:
    EndpointOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Endpoint
extends com.google.protobuf.GeneratedMessageV3
implements EndpointOrBuilder
     Source or destination of the Connectivity Test.
    Protobuf type google.cloud.networkmanagement.v1.Endpoint
    See Also:
    Serialized Form

    • Field Detail

      • IP_ADDRESS_FIELD_NUMBER

        public static final int IP_ADDRESS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FORWARDING_RULE_FIELD_NUMBER

        public static final int FORWARDING_RULE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FORWARDING_RULE_TARGET_FIELD_NUMBER

        public static final int FORWARDING_RULE_TARGET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOAD_BALANCER_ID_FIELD_NUMBER

        public static final int LOAD_BALANCER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOAD_BALANCER_TYPE_FIELD_NUMBER

        public static final int LOAD_BALANCER_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GKE_MASTER_CLUSTER_FIELD_NUMBER

        public static final int GKE_MASTER_CLUSTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLOUD_SQL_INSTANCE_FIELD_NUMBER

        public static final int CLOUD_SQL_INSTANCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLOUD_FUNCTION_FIELD_NUMBER

        public static final int CLOUD_FUNCTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • APP_ENGINE_VERSION_FIELD_NUMBER

        public static final int APP_ENGINE_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLOUD_RUN_REVISION_FIELD_NUMBER

        public static final int CLOUD_RUN_REVISION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NETWORK_TYPE_FIELD_NUMBER

        public static final int NETWORK_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROJECT_ID_FIELD_NUMBER

        public static final int PROJECT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getIpAddress

        public String getIpAddress()
         The IP address of the endpoint, which can be an external or internal IP.
 An IPv6 address is only allowed when the test's destination is a
 [global load balancer
 VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
        string ip_address = 1;
        Specified by:
        getIpAddress in interface EndpointOrBuilder
        Returns:
        The ipAddress.

      • getIpAddressBytes

        public com.google.protobuf.ByteString getIpAddressBytes()
         The IP address of the endpoint, which can be an external or internal IP.
 An IPv6 address is only allowed when the test's destination is a
 [global load balancer
 VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
        string ip_address = 1;
        Specified by:
        getIpAddressBytes in interface EndpointOrBuilder
        Returns:
        The bytes for ipAddress.

      • getPort

        public int getPort()
         The IP protocol port of the endpoint.
 Only applicable when protocol is TCP or UDP.
        int32 port = 2;
        Specified by:
        getPort in interface EndpointOrBuilder
        Returns:
        The port.

      • getInstance

        public String getInstance()
         A Compute Engine instance URI.
        string instance = 3;
        Specified by:
        getInstance in interface EndpointOrBuilder
        Returns:
        The instance.

      • getInstanceBytes

        public com.google.protobuf.ByteString getInstanceBytes()
         A Compute Engine instance URI.
        string instance = 3;
        Specified by:
        getInstanceBytes in interface EndpointOrBuilder
        Returns:
        The bytes for instance.

      • getForwardingRule

        public String getForwardingRule()
         A forwarding rule and its corresponding IP address represent the frontend
 configuration of a Google Cloud load balancer. Forwarding rules are also
 used for protocol forwarding, Private Service Connect and other network
 services to provide forwarding information in the control plane. Format:
  projects/{project}/global/forwardingRules/{id} or
  projects/{project}/regions/{region}/forwardingRules/{id}
        string forwarding_rule = 13;
        Specified by:
        getForwardingRule in interface EndpointOrBuilder
        Returns:
        The forwardingRule.

      • getForwardingRuleBytes

        public com.google.protobuf.ByteString getForwardingRuleBytes()
         A forwarding rule and its corresponding IP address represent the frontend
 configuration of a Google Cloud load balancer. Forwarding rules are also
 used for protocol forwarding, Private Service Connect and other network
 services to provide forwarding information in the control plane. Format:
  projects/{project}/global/forwardingRules/{id} or
  projects/{project}/regions/{region}/forwardingRules/{id}
        string forwarding_rule = 13;
        Specified by:
        getForwardingRuleBytes in interface EndpointOrBuilder
        Returns:
        The bytes for forwardingRule.

      • hasForwardingRuleTarget

        public boolean hasForwardingRuleTarget()
         Output only. Specifies the type of the target of the forwarding rule.
        optional .google.cloud.networkmanagement.v1.Endpoint.ForwardingRuleTarget forwarding_rule_target = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasForwardingRuleTarget in interface EndpointOrBuilder
        Returns:
        Whether the forwardingRuleTarget field is set.

      • getForwardingRuleTargetValue

        public int getForwardingRuleTargetValue()
         Output only. Specifies the type of the target of the forwarding rule.
        optional .google.cloud.networkmanagement.v1.Endpoint.ForwardingRuleTarget forwarding_rule_target = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getForwardingRuleTargetValue in interface EndpointOrBuilder
        Returns:
        The enum numeric value on the wire for forwardingRuleTarget.

      • getForwardingRuleTarget

        public Endpoint.ForwardingRuleTarget getForwardingRuleTarget()
         Output only. Specifies the type of the target of the forwarding rule.
        optional .google.cloud.networkmanagement.v1.Endpoint.ForwardingRuleTarget forwarding_rule_target = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getForwardingRuleTarget in interface EndpointOrBuilder
        Returns:
        The forwardingRuleTarget.

      • hasLoadBalancerId

        public boolean hasLoadBalancerId()
         Output only. ID of the load balancer the forwarding rule points to. Empty
 for forwarding rules not related to load balancers.
        optional string load_balancer_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasLoadBalancerId in interface EndpointOrBuilder
        Returns:
        Whether the loadBalancerId field is set.

      • getLoadBalancerId

        public String getLoadBalancerId()
         Output only. ID of the load balancer the forwarding rule points to. Empty
 for forwarding rules not related to load balancers.
        optional string load_balancer_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLoadBalancerId in interface EndpointOrBuilder
        Returns:
        The loadBalancerId.

      • getLoadBalancerIdBytes

        public com.google.protobuf.ByteString getLoadBalancerIdBytes()
         Output only. ID of the load balancer the forwarding rule points to. Empty
 for forwarding rules not related to load balancers.
        optional string load_balancer_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLoadBalancerIdBytes in interface EndpointOrBuilder
        Returns:
        The bytes for loadBalancerId.

      • hasLoadBalancerType

        public boolean hasLoadBalancerType()
         Output only. Type of the load balancer the forwarding rule points to.
        optional .google.cloud.networkmanagement.v1.LoadBalancerType load_balancer_type = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasLoadBalancerType in interface EndpointOrBuilder
        Returns:
        Whether the loadBalancerType field is set.

      • getLoadBalancerTypeValue

        public int getLoadBalancerTypeValue()
         Output only. Type of the load balancer the forwarding rule points to.
        optional .google.cloud.networkmanagement.v1.LoadBalancerType load_balancer_type = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLoadBalancerTypeValue in interface EndpointOrBuilder
        Returns:
        The enum numeric value on the wire for loadBalancerType.

      • getLoadBalancerType

        public LoadBalancerType getLoadBalancerType()
         Output only. Type of the load balancer the forwarding rule points to.
        optional .google.cloud.networkmanagement.v1.LoadBalancerType load_balancer_type = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLoadBalancerType in interface EndpointOrBuilder
        Returns:
        The loadBalancerType.

      • getGkeMasterCluster

        public String getGkeMasterCluster()
         A cluster URI for [Google Kubernetes Engine
 master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
        string gke_master_cluster = 7;
        Specified by:
        getGkeMasterCluster in interface EndpointOrBuilder
        Returns:
        The gkeMasterCluster.

      • getGkeMasterClusterBytes

        public com.google.protobuf.ByteString getGkeMasterClusterBytes()
         A cluster URI for [Google Kubernetes Engine
 master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
        string gke_master_cluster = 7;
        Specified by:
        getGkeMasterClusterBytes in interface EndpointOrBuilder
        Returns:
        The bytes for gkeMasterCluster.

      • getCloudSqlInstance

        public String getCloudSqlInstance()
         A [Cloud SQL](https://cloud.google.com/sql) instance URI.
        string cloud_sql_instance = 8;
        Specified by:
        getCloudSqlInstance in interface EndpointOrBuilder
        Returns:
        The cloudSqlInstance.

      • getCloudSqlInstanceBytes

        public com.google.protobuf.ByteString getCloudSqlInstanceBytes()
         A [Cloud SQL](https://cloud.google.com/sql) instance URI.
        string cloud_sql_instance = 8;
        Specified by:
        getCloudSqlInstanceBytes in interface EndpointOrBuilder
        Returns:
        The bytes for cloudSqlInstance.

      • hasCloudFunction

        public boolean hasCloudFunction()
         A [Cloud Function](https://cloud.google.com/functions).
        .google.cloud.networkmanagement.v1.Endpoint.CloudFunctionEndpoint cloud_function = 10;
        Specified by:
        hasCloudFunction in interface EndpointOrBuilder
        Returns:
        Whether the cloudFunction field is set.

      • hasAppEngineVersion

        public boolean hasAppEngineVersion()
         An [App Engine](https://cloud.google.com/appengine) [service
 version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
        .google.cloud.networkmanagement.v1.Endpoint.AppEngineVersionEndpoint app_engine_version = 11;
        Specified by:
        hasAppEngineVersion in interface EndpointOrBuilder
        Returns:
        Whether the appEngineVersion field is set.

      • getAppEngineVersion

        public Endpoint.AppEngineVersionEndpoint getAppEngineVersion()
         An [App Engine](https://cloud.google.com/appengine) [service
 version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
        .google.cloud.networkmanagement.v1.Endpoint.AppEngineVersionEndpoint app_engine_version = 11;
        Specified by:
        getAppEngineVersion in interface EndpointOrBuilder
        Returns:
        The appEngineVersion.

      • getAppEngineVersionOrBuilder

        public Endpoint.AppEngineVersionEndpointOrBuilder getAppEngineVersionOrBuilder()
         An [App Engine](https://cloud.google.com/appengine) [service
 version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
        .google.cloud.networkmanagement.v1.Endpoint.AppEngineVersionEndpoint app_engine_version = 11;
        Specified by:
        getAppEngineVersionOrBuilder in interface EndpointOrBuilder

      • hasCloudRunRevision

        public boolean hasCloudRunRevision()
         A [Cloud Run](https://cloud.google.com/run)
 [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get)
        .google.cloud.networkmanagement.v1.Endpoint.CloudRunRevisionEndpoint cloud_run_revision = 12;
        Specified by:
        hasCloudRunRevision in interface EndpointOrBuilder
        Returns:
        Whether the cloudRunRevision field is set.

      • getCloudRunRevision

        public Endpoint.CloudRunRevisionEndpoint getCloudRunRevision()
         A [Cloud Run](https://cloud.google.com/run)
 [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get)
        .google.cloud.networkmanagement.v1.Endpoint.CloudRunRevisionEndpoint cloud_run_revision = 12;
        Specified by:
        getCloudRunRevision in interface EndpointOrBuilder
        Returns:
        The cloudRunRevision.

      • getNetwork

        public String getNetwork()
         A Compute Engine network URI.
        string network = 4;
        Specified by:
        getNetwork in interface EndpointOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         A Compute Engine network URI.
        string network = 4;
        Specified by:
        getNetworkBytes in interface EndpointOrBuilder
        Returns:
        The bytes for network.

      • getNetworkTypeValue

        public int getNetworkTypeValue()
         Type of the network where the endpoint is located.
 Applicable only to source endpoint, as destination network type can be
 inferred from the source.
        .google.cloud.networkmanagement.v1.Endpoint.NetworkType network_type = 5;
        Specified by:
        getNetworkTypeValue in interface EndpointOrBuilder
        Returns:
        The enum numeric value on the wire for networkType.

      • getNetworkType

        public Endpoint.NetworkType getNetworkType()
         Type of the network where the endpoint is located.
 Applicable only to source endpoint, as destination network type can be
 inferred from the source.
        .google.cloud.networkmanagement.v1.Endpoint.NetworkType network_type = 5;
        Specified by:
        getNetworkType in interface EndpointOrBuilder
        Returns:
        The networkType.

      • getProjectId

        public String getProjectId()
         Project ID where the endpoint is located.
 The Project ID can be derived from the URI if you provide a VM instance or
 network URI.
 The following are two cases where you must provide the project ID:
 1. Only the IP address is specified, and the IP address is within a Google
 Cloud project.
 2. When you are using Shared VPC and the IP address that you provide is
 from the service project. In this case, the network that the IP address
 resides in is defined in the host project.
        string project_id = 6;
        Specified by:
        getProjectId in interface EndpointOrBuilder
        Returns:
        The projectId.

      • getProjectIdBytes

        public com.google.protobuf.ByteString getProjectIdBytes()
         Project ID where the endpoint is located.
 The Project ID can be derived from the URI if you provide a VM instance or
 network URI.
 The following are two cases where you must provide the project ID:
 1. Only the IP address is specified, and the IP address is within a Google
 Cloud project.
 2. When you are using Shared VPC and the IP address that you provide is
 from the service project. In this case, the network that the IP address
 resides in is defined in the host project.
        string project_id = 6;
        Specified by:
        getProjectIdBytes in interface EndpointOrBuilder
        Returns:
        The bytes for projectId.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Endpoint getDefaultInstance()

      • parser

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

      • getParserForType

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