Reference documentation and code samples for the Google Cloud Network Management V1 Client class Endpoint.
Source or destination of the Connectivity Test.
Generated from protobuf message google.cloud.networkmanagement.v1.Endpoint
Namespace
Google \ Cloud \ NetworkManagement \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ ip_address
string
The IP address of the endpoint, which can be an external or internal IP.
↳ port
int
The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
↳ instance
string
A Compute Engine instance URI.
↳ forwarding_rule
string
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. Applicable only to destination endpoint. Format: projects/{project}/global/forwardingRules/{id}
or projects/{project}/regions/{region}/forwardingRules/{id}
↳ forwarding_rule_target
int
Output only. Specifies the type of the target of the forwarding rule.
↳ load_balancer_id
string
Output only. ID of the load balancer the forwarding rule points to. Empty for forwarding rules not related to load balancers.
↳ load_balancer_type
int
Output only. Type of the load balancer the forwarding rule points to.
↳ gke_master_cluster
↳ fqdn
string
DNS endpoint of Google Kubernetes Engine cluster control plane . Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint.
↳ cloud_sql_instance
↳ redis_instance
↳ redis_cluster
↳ cloud_function
↳ app_engine_version
Endpoint\AppEngineVersionEndpoint
An App Engine service version . Applicable only to source endpoint.
↳ cloud_run_revision
↳ network
string
A VPC network URI.
↳ network_type
int
Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.
↳ project_id
string
Project ID where the endpoint is located. The project ID can be derived from the URI if you provide a endpoint or network URI. The following are two cases where you may need to 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.
getIpAddress
The IP address of the endpoint, which can be an external or internal IP.
string
setIpAddress
The IP address of the endpoint, which can be an external or internal IP.
var
string
$this
getPort
The IP protocol port of the endpoint.
Only applicable when protocol is TCP or UDP.
int
setPort
The IP protocol port of the endpoint.
Only applicable when protocol is TCP or UDP.
var
int
$this
getInstance
A Compute Engine instance URI.
string
setInstance
A Compute Engine instance URI.
var
string
$this
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. Applicable
only to destination endpoint. Format: projects/{project}/global/forwardingRules/{id}
or projects/{project}/regions/{region}/forwardingRules/{id}
string
setForwardingRule
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. Applicable
only to destination endpoint. Format: projects/{project}/global/forwardingRules/{id}
or projects/{project}/regions/{region}/forwardingRules/{id}
var
string
$this
getForwardingRuleTarget
Output only. Specifies the type of the target of the forwarding rule.
int
hasForwardingRuleTarget
clearForwardingRuleTarget
setForwardingRuleTarget
Output only. Specifies the type of the target of the forwarding rule.
var
int
$this
getLoadBalancerId
Output only. ID of the load balancer the forwarding rule points to. Empty for forwarding rules not related to load balancers.
string
hasLoadBalancerId
clearLoadBalancerId
setLoadBalancerId
Output only. ID of the load balancer the forwarding rule points to. Empty for forwarding rules not related to load balancers.
var
string
$this
getLoadBalancerType
Output only. Type of the load balancer the forwarding rule points to.
int
hasLoadBalancerType
clearLoadBalancerType
setLoadBalancerType
Output only. Type of the load balancer the forwarding rule points to.
var
int
$this
getGkeMasterCluster
A cluster URI for Google Kubernetes Engine cluster control plane .
string
setGkeMasterCluster
A cluster URI for Google Kubernetes Engine cluster control plane .
var
string
$this
getFqdn
DNS endpoint of Google Kubernetes Engine cluster control plane .
Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint.
string
setFqdn
DNS endpoint of Google Kubernetes Engine cluster control plane .
Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint.
var
string
$this
getCloudSqlInstance
A Cloud SQL instance URI.
string
setCloudSqlInstance
A Cloud SQL instance URI.
var
string
$this
getRedisInstance
A Redis Instance URI.
Applicable only to destination endpoint.
string
setRedisInstance
A Redis Instance URI.
Applicable only to destination endpoint.
var
string
$this
getRedisCluster
A Redis Cluster URI.
Applicable only to destination endpoint.
string
setRedisCluster
A Redis Cluster URI.
Applicable only to destination endpoint.
var
string
$this
getCloudFunction
A Cloud Function . Applicable only to source endpoint.
hasCloudFunction
clearCloudFunction
setCloudFunction
A Cloud Function . Applicable only to source endpoint.
$this
getAppEngineVersion
An App Engine service version .
Applicable only to source endpoint.
hasAppEngineVersion
clearAppEngineVersion
setAppEngineVersion
An App Engine service version .
Applicable only to source endpoint.
$this
getCloudRunRevision
hasCloudRunRevision
clearCloudRunRevision
setCloudRunRevision
$this
getNetwork
A VPC network URI.
string
setNetwork
A VPC network URI.
var
string
$this
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.
int
setNetworkType
Type of the network where the endpoint is located.
Applicable only to source endpoint, as destination network type can be inferred from the source.
var
int
$this
getProjectId
Project ID where the endpoint is located.
The project ID can be derived from the URI if you provide a endpoint or network URI. The following are two cases where you may need to provide the project ID:
- Only the IP address is specified, and the IP address is within a Google Cloud project.
- 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
setProjectId
Project ID where the endpoint is located.
The project ID can be derived from the URI if you provide a endpoint or network URI. The following are two cases where you may need to provide the project ID:
- Only the IP address is specified, and the IP address is within a Google Cloud project.
- 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.
var
string
$this
