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

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. 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
string

A Cloud SQL instance URI.

↳ redis_instance
string

A Redis Instance URI. Applicable only to destination endpoint.

↳ redis_cluster
string

A Redis Cluster URI. Applicable only to destination endpoint.

↳ gke_pod
string

A GKE Pod URI.

↳ cloud_function
Endpoint\CloudFunctionEndpoint

A Cloud Function . Applicable only to source endpoint.

↳ app_engine_version
Endpoint\AppEngineVersionEndpoint

An App Engine service version . Applicable only to source endpoint.

↳ cloud_run_revision
Endpoint\CloudRunRevisionEndpoint

A Cloud Run revision Applicable only to source endpoint.

↳ network
string

A VPC network URI. For source endpoints, used according to the network_type . For destination endpoints, used only when the source is an external IP address endpoint, and the destination is an internal IP address endpoint.

↳ network_type
int

For source endpoints, type of the network where the endpoint is located. Not relevant for destination endpoints.

↳ project_id
string

For source endpoints, endpoint project ID. Used according to the network_type . Not relevant for destination endpoints.

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. Applicable only to destination endpoint. 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. Applicable only to destination endpoint. 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

Returns
Type
Description
string

setGkeMasterCluster

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.

Applicable only to destination endpoint.

Returns
Type
Description
string

setRedisInstance

A Redis Instance URI.

Applicable only to destination endpoint.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getRedisCluster

A Redis Cluster URI.

Applicable only to destination endpoint.

Returns
Type
Description
string

setRedisCluster

A Redis Cluster URI.

Applicable only to destination endpoint.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getGkePod

A GKE Pod URI.

Returns
Type
Description
string

setGkePod

A GKE Pod URI.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCloudFunction

A Cloud Function . Applicable only to source endpoint.

Returns
Type
Description

hasCloudFunction

clearCloudFunction

setCloudFunction

A Cloud Function . Applicable only to source endpoint.

Parameter
Name
Description
Returns
Type
Description
$this

getAppEngineVersion

An App Engine service version .

Applicable only to source endpoint.

Returns
Type
Description

hasAppEngineVersion

clearAppEngineVersion

setAppEngineVersion

An App Engine service version .

Applicable only to source endpoint.

Parameter
Name
Description
Returns
Type
Description
$this

getCloudRunRevision

A Cloud Run revision Applicable only to source endpoint.

Returns
Type
Description

hasCloudRunRevision

clearCloudRunRevision

setCloudRunRevision

A Cloud Run revision Applicable only to source endpoint.

Parameter
Name
Description
Returns
Type
Description
$this

getNetwork

A VPC network URI. For source endpoints, used according to the network_type . For destination endpoints, used only when the source is an external IP address endpoint, and the destination is an internal IP address endpoint.

Returns
Type
Description
string

setNetwork

A VPC network URI. For source endpoints, used according to the network_type . For destination endpoints, used only when the source is an external IP address endpoint, and the destination is an internal IP address endpoint.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNetworkType

For source endpoints, type of the network where the endpoint is located.

Not relevant for destination endpoints.

Returns
Type
Description
int
Enum of type NetworkType .

setNetworkType

For source endpoints, type of the network where the endpoint is located.

Not relevant for destination endpoints.

Parameter
Name
Description
var
int

Enum of type NetworkType .

Returns
Type
Description
$this

getProjectId

For source endpoints, endpoint project ID. Used according to the network_type . Not relevant for destination endpoints.

Returns
Type
Description
string

setProjectId

For source endpoints, endpoint project ID. Used according to the network_type . Not relevant for destination endpoints.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: