Google Cloud Network Management V1 Client - Class Endpoint (2.2.1)

Version latest

• 2.2.1 (latest)
• 2.2.0
• 2.1.1
• 2.0.1
• 1.7.3
• 1.5.0
• 1.4.2
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.5

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
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. 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	string A cluster URI for Google Kubernetes Engine cluster control plane.
↳ 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	string A Cloud SQL instance URI.
↳ redis_instance	string A Redis Instance URI.
↳ redis_cluster	string A Redis Cluster URI.
↳ cloud_function	Endpoint\CloudFunctionEndpoint A Cloud Function.
↳ app_engine_version	Endpoint\AppEngineVersionEndpoint An App Engine service version.
↳ cloud_run_revision	Endpoint\CloudRunRevisionEndpoint A Cloud Run revision
↳ network	string A Compute Engine 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 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.

getIpAddress

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

Returns
Type	Description
string

setIpAddress

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPort

The IP protocol port of the endpoint.

Only applicable when protocol is TCP or UDP.

Returns
Type	Description
int

setPort

The IP protocol port of the endpoint.

Only applicable when protocol is TCP or UDP.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getInstance

A Compute Engine instance URI.

Returns
Type	Description
string

setInstance

A Compute Engine instance URI.

Parameter
Name	Description
var	string

Returns
Type	Description
$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. Format: projects/{project}/global/forwardingRules/{id} or projects/{project}/regions/{region}/forwardingRules/{id}

Returns
Type	Description
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. Format: projects/{project}/global/forwardingRules/{id} or projects/{project}/regions/{region}/forwardingRules/{id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getForwardingRuleTarget

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

Returns
Type	Description
int

hasForwardingRuleTarget

clearForwardingRuleTarget

setForwardingRuleTarget

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getLoadBalancerId

Output only. ID of the load balancer the forwarding rule points to. Empty for forwarding rules not related to load balancers.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLoadBalancerType

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

Returns
Type	Description
int

hasLoadBalancerType

clearLoadBalancerType

setLoadBalancerType

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getGkeMasterCluster

A cluster URI for Google Kubernetes Engine cluster control plane.

Returns
Type	Description
string

setGkeMasterCluster

A cluster URI for Google Kubernetes Engine cluster control plane.

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCloudSqlInstance

A Cloud SQL instance URI.

Returns
Type	Description
string

setCloudSqlInstance

A Cloud SQL instance URI.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRedisInstance

A Redis Instance URI.

Returns
Type	Description
string

setRedisInstance

A Redis Instance URI.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRedisCluster

A Redis Cluster URI.

Returns
Type	Description
string

setRedisCluster

A Redis Cluster URI.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCloudFunction

A Cloud Function.

Returns
Type	Description
Endpoint\CloudFunctionEndpoint|null

hasCloudFunction

clearCloudFunction

setCloudFunction

A Cloud Function.

Parameter
Name	Description
var	Endpoint\CloudFunctionEndpoint

Returns
Type	Description
$this

getAppEngineVersion

An App Engine service version.

Returns
Type	Description
Endpoint\AppEngineVersionEndpoint|null

hasAppEngineVersion

clearAppEngineVersion

setAppEngineVersion

An App Engine service version.

Parameter
Name	Description
var	Endpoint\AppEngineVersionEndpoint

Returns
Type	Description
$this

getCloudRunRevision

A Cloud Run revision

Returns
Type	Description
Endpoint\CloudRunRevisionEndpoint|null

hasCloudRunRevision

clearCloudRunRevision

setCloudRunRevision

A Cloud Run revision

Parameter
Name	Description
var	Endpoint\CloudRunRevisionEndpoint

Returns
Type	Description
$this

getNetwork

A Compute Engine network URI.

Returns
Type	Description
string

setNetwork

A Compute Engine network URI.

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

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.

Returns
Type	Description
string

setProjectId

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this