Google Cloud Network Management V1 Client - Class Endpoint (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

Methods

__construct

Constructor.

Parameters
NameDescription
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. An IPv6 address is only allowed when the test's destination is a global load balancer VIP.

↳ port int

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

↳ instance string

A Compute Engine instance URI.

↳ gke_master_cluster string

A cluster URI for Google Kubernetes Engine master.

↳ cloud_sql_instance string

A Cloud SQL instance URI.

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

An IPv6 address is only allowed when the test's destination is a global load balancer VIP.

Returns
TypeDescription
string

setIpAddress

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPort

The IP protocol port of the endpoint.

Only applicable when protocol is TCP or UDP.

Returns
TypeDescription
int

setPort

The IP protocol port of the endpoint.

Only applicable when protocol is TCP or UDP.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getInstance

A Compute Engine instance URI.

Returns
TypeDescription
string

setInstance

A Compute Engine instance URI.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGkeMasterCluster

Returns
TypeDescription
string

setGkeMasterCluster

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCloudSqlInstance

A Cloud SQL instance URI.

Returns
TypeDescription
string

setCloudSqlInstance

A Cloud SQL instance URI.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNetwork

A Compute Engine network URI.

Returns
TypeDescription
string

setNetwork

A Compute Engine network URI.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this