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 | |
|---|---|
| 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. 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 | |
getGkeMasterCluster
A cluster URI for Google Kubernetes Engine master.
| Returns | |
|---|---|
| Type | Description |
string | |
setGkeMasterCluster
A cluster URI for Google Kubernetes Engine master.
| 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 | |
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:
- 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.
| 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:
- 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |