Class Endpoint (1.47.0) 

public final class Endpoint extends GeneratedMessageV3 implements EndpointOrBuilder

Source or destination of the Connectivity Test.

Protobuf type google.cloud.networkmanagement.v1beta1.Endpoint

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Endpoint

Implements

EndpointOrBuilder

Static Fields

APP_ENGINE_VERSION_FIELD_NUMBER

public static final int APP_ENGINE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_FUNCTION_FIELD_NUMBER

public static final int CLOUD_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_RUN_REVISION_FIELD_NUMBER

public static final int CLOUD_RUN_REVISION_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_SQL_INSTANCE_FIELD_NUMBER

public static final int CLOUD_SQL_INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

FORWARDING_RULE_FIELD_NUMBER

public static final int FORWARDING_RULE_FIELD_NUMBER
Field Value
Type Description
int

FORWARDING_RULE_TARGET_FIELD_NUMBER

public static final int FORWARDING_RULE_TARGET_FIELD_NUMBER
Field Value
Type Description
int

GKE_MASTER_CLUSTER_FIELD_NUMBER

public static final int GKE_MASTER_CLUSTER_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

IP_ADDRESS_FIELD_NUMBER

public static final int IP_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

LOAD_BALANCER_ID_FIELD_NUMBER

public static final int LOAD_BALANCER_ID_FIELD_NUMBER
Field Value
Type Description
int

LOAD_BALANCER_TYPE_FIELD_NUMBER

public static final int LOAD_BALANCER_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_TYPE_FIELD_NUMBER

public static final int NETWORK_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Endpoint getDefaultInstance()
Returns
Type Description
Endpoint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Endpoint.Builder newBuilder()
Returns
Type Description
Endpoint.Builder

newBuilder(Endpoint prototype)

public static Endpoint.Builder newBuilder(Endpoint prototype)
Parameter
Name Description
prototype Endpoint
Returns
Type Description
Endpoint.Builder

parseDelimitedFrom(InputStream input)

public static Endpoint parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Endpoint
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Endpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Endpoint
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Endpoint parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Endpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Endpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Endpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Endpoint parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Endpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Endpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Endpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Endpoint parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Endpoint
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Endpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Endpoint
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Endpoint parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Endpoint
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Endpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Endpoint
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Endpoint parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Endpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Endpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Endpoint
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Endpoint> parser()
Returns
Type Description
Parser<Endpoint>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAppEngineVersion()

public Endpoint.AppEngineVersionEndpoint getAppEngineVersion()

An App Engine service version.

.google.cloud.networkmanagement.v1beta1.Endpoint.AppEngineVersionEndpoint app_engine_version = 11;

Returns
Type Description
Endpoint.AppEngineVersionEndpoint

The appEngineVersion.

getAppEngineVersionOrBuilder()

public Endpoint.AppEngineVersionEndpointOrBuilder getAppEngineVersionOrBuilder()

An App Engine service version.

.google.cloud.networkmanagement.v1beta1.Endpoint.AppEngineVersionEndpoint app_engine_version = 11;

Returns
Type Description
Endpoint.AppEngineVersionEndpointOrBuilder

getCloudFunction()

public Endpoint.CloudFunctionEndpoint getCloudFunction()

A Cloud Function.

.google.cloud.networkmanagement.v1beta1.Endpoint.CloudFunctionEndpoint cloud_function = 10;

Returns
Type Description
Endpoint.CloudFunctionEndpoint

The cloudFunction.

getCloudFunctionOrBuilder()

public Endpoint.CloudFunctionEndpointOrBuilder getCloudFunctionOrBuilder()

A Cloud Function.

.google.cloud.networkmanagement.v1beta1.Endpoint.CloudFunctionEndpoint cloud_function = 10;

Returns
Type Description
Endpoint.CloudFunctionEndpointOrBuilder

getCloudRunRevision()

public Endpoint.CloudRunRevisionEndpoint getCloudRunRevision()

A Cloud Run revision

.google.cloud.networkmanagement.v1beta1.Endpoint.CloudRunRevisionEndpoint cloud_run_revision = 12;

Returns
Type Description
Endpoint.CloudRunRevisionEndpoint

The cloudRunRevision.

getCloudRunRevisionOrBuilder()

public Endpoint.CloudRunRevisionEndpointOrBuilder getCloudRunRevisionOrBuilder()

A Cloud Run revision

.google.cloud.networkmanagement.v1beta1.Endpoint.CloudRunRevisionEndpoint cloud_run_revision = 12;

Returns
Type Description
Endpoint.CloudRunRevisionEndpointOrBuilder

getCloudSqlInstance()

public String getCloudSqlInstance()

A Cloud SQL instance URI.

string cloud_sql_instance = 8;

Returns
Type Description
String

The cloudSqlInstance.

getCloudSqlInstanceBytes()

public ByteString getCloudSqlInstanceBytes()

A Cloud SQL instance URI.

string cloud_sql_instance = 8;

Returns
Type Description
ByteString

The bytes for cloudSqlInstance.

getDefaultInstanceForType()

public Endpoint getDefaultInstanceForType()
Returns
Type Description
Endpoint

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;

Returns
Type Description
String

The forwardingRule.

getForwardingRuleBytes()

public 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;

Returns
Type Description
ByteString

The bytes for forwardingRule.

getForwardingRuleTarget()

public Endpoint.ForwardingRuleTarget getForwardingRuleTarget()

Output only. Specifies the type of the target of the forwarding rule.

optional .google.cloud.networkmanagement.v1beta1.Endpoint.ForwardingRuleTarget forwarding_rule_target = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Endpoint.ForwardingRuleTarget

The forwardingRuleTarget.

getForwardingRuleTargetValue()

public int getForwardingRuleTargetValue()

Output only. Specifies the type of the target of the forwarding rule.

optional .google.cloud.networkmanagement.v1beta1.Endpoint.ForwardingRuleTarget forwarding_rule_target = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for forwardingRuleTarget.

getGkeMasterCluster()

public String getGkeMasterCluster()

A cluster URI for Google Kubernetes Engine master.

string gke_master_cluster = 7;

Returns
Type Description
String

The gkeMasterCluster.

getGkeMasterClusterBytes()

public ByteString getGkeMasterClusterBytes()

A cluster URI for Google Kubernetes Engine master.

string gke_master_cluster = 7;

Returns
Type Description
ByteString

The bytes for gkeMasterCluster.

getInstance()

public String getInstance()

A Compute Engine instance URI.

string instance = 3;

Returns
Type Description
String

The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

A Compute Engine instance URI.

string instance = 3;

Returns
Type Description
ByteString

The bytes for instance.

getIpAddress()

public String getIpAddress()

The IP address of the endpoint, which can be an external or internal IP.

string ip_address = 1;

Returns
Type Description
String

The ipAddress.

getIpAddressBytes()

public ByteString getIpAddressBytes()

The IP address of the endpoint, which can be an external or internal IP.

string ip_address = 1;

Returns
Type Description
ByteString

The bytes for ipAddress.

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];

Returns
Type Description
String

The loadBalancerId.

getLoadBalancerIdBytes()

public 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];

Returns
Type Description
ByteString

The bytes for loadBalancerId.

getLoadBalancerType()

public LoadBalancerType getLoadBalancerType()

Output only. Type of the load balancer the forwarding rule points to.

optional .google.cloud.networkmanagement.v1beta1.LoadBalancerType load_balancer_type = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LoadBalancerType

The loadBalancerType.

getLoadBalancerTypeValue()

public int getLoadBalancerTypeValue()

Output only. Type of the load balancer the forwarding rule points to.

optional .google.cloud.networkmanagement.v1beta1.LoadBalancerType load_balancer_type = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for loadBalancerType.

getNetwork()

public String getNetwork()

A Compute Engine network URI.

string network = 4;

Returns
Type Description
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

A Compute Engine network URI.

string network = 4;

Returns
Type Description
ByteString

The bytes for network.

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.v1beta1.Endpoint.NetworkType network_type = 5;

Returns
Type Description
Endpoint.NetworkType

The networkType.

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.v1beta1.Endpoint.NetworkType network_type = 5;

Returns
Type Description
int

The enum numeric value on the wire for networkType.

getParserForType()

public Parser<Endpoint> getParserForType()
Returns
Type Description
Parser<Endpoint>
Overrides

getPort()

public int getPort()

The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.

int32 port = 2;

Returns
Type Description
int

The port.

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;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public 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;

Returns
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAppEngineVersion()

public boolean hasAppEngineVersion()

An App Engine service version.

.google.cloud.networkmanagement.v1beta1.Endpoint.AppEngineVersionEndpoint app_engine_version = 11;

Returns
Type Description
boolean

Whether the appEngineVersion field is set.

hasCloudFunction()

public boolean hasCloudFunction()

A Cloud Function.

.google.cloud.networkmanagement.v1beta1.Endpoint.CloudFunctionEndpoint cloud_function = 10;

Returns
Type Description
boolean

Whether the cloudFunction field is set.

hasCloudRunRevision()

public boolean hasCloudRunRevision()

A Cloud Run revision

.google.cloud.networkmanagement.v1beta1.Endpoint.CloudRunRevisionEndpoint cloud_run_revision = 12;

Returns
Type Description
boolean

Whether the cloudRunRevision field is set.

hasForwardingRuleTarget()

public boolean hasForwardingRuleTarget()

Output only. Specifies the type of the target of the forwarding rule.

optional .google.cloud.networkmanagement.v1beta1.Endpoint.ForwardingRuleTarget forwarding_rule_target = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the forwardingRuleTarget field is set.

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];

Returns
Type Description
boolean

Whether the loadBalancerId field is set.

hasLoadBalancerType()

public boolean hasLoadBalancerType()

Output only. Type of the load balancer the forwarding rule points to.

optional .google.cloud.networkmanagement.v1beta1.LoadBalancerType load_balancer_type = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the loadBalancerType field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Endpoint.Builder newBuilderForType()
Returns
Type Description
Endpoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Endpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Endpoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Endpoint.Builder toBuilder()
Returns
Type Description
Endpoint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException