Network Management V1 API - Class Google::Cloud::NetworkManagement::V1::Endpoint (v1.2.0)

Reference documentation and code samples for the Network Management V1 API class Google::Cloud::NetworkManagement::V1::Endpoint.

Source or destination of the Connectivity Test.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#app_engine_version

def app_engine_version() -> ::Google::Cloud::NetworkManagement::V1::Endpoint::AppEngineVersionEndpoint

Returns

(::Google::Cloud::NetworkManagement::V1::Endpoint::AppEngineVersionEndpoint) — An App Engine service version.

#app_engine_version=

def app_engine_version=(value) -> ::Google::Cloud::NetworkManagement::V1::Endpoint::AppEngineVersionEndpoint

Parameter

value (::Google::Cloud::NetworkManagement::V1::Endpoint::AppEngineVersionEndpoint) — An App Engine service version.

Returns

(::Google::Cloud::NetworkManagement::V1::Endpoint::AppEngineVersionEndpoint) — An App Engine service version.

#cloud_function

def cloud_function() -> ::Google::Cloud::NetworkManagement::V1::Endpoint::CloudFunctionEndpoint

Returns

(::Google::Cloud::NetworkManagement::V1::Endpoint::CloudFunctionEndpoint) — A Cloud Function.

#cloud_function=

def cloud_function=(value) -> ::Google::Cloud::NetworkManagement::V1::Endpoint::CloudFunctionEndpoint

Parameter

value (::Google::Cloud::NetworkManagement::V1::Endpoint::CloudFunctionEndpoint) — A Cloud Function.

Returns

(::Google::Cloud::NetworkManagement::V1::Endpoint::CloudFunctionEndpoint) — A Cloud Function.

#cloud_run_revision

def cloud_run_revision() -> ::Google::Cloud::NetworkManagement::V1::Endpoint::CloudRunRevisionEndpoint

Returns

(::Google::Cloud::NetworkManagement::V1::Endpoint::CloudRunRevisionEndpoint) — A Cloud Run revision

#cloud_run_revision=

def cloud_run_revision=(value) -> ::Google::Cloud::NetworkManagement::V1::Endpoint::CloudRunRevisionEndpoint

Parameter

value (::Google::Cloud::NetworkManagement::V1::Endpoint::CloudRunRevisionEndpoint) — A Cloud Run revision

Returns

(::Google::Cloud::NetworkManagement::V1::Endpoint::CloudRunRevisionEndpoint) — A Cloud Run revision

#cloud_sql_instance

def cloud_sql_instance() -> ::String

Returns

(::String) — A Cloud SQL instance URI.

#cloud_sql_instance=

def cloud_sql_instance=(value) -> ::String

Parameter

value (::String) — A Cloud SQL instance URI.

Returns

(::String) — A Cloud SQL instance URI.

#forwarding_rule

def forwarding_rule() -> ::String

Returns

(::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=

def forwarding_rule=(value) -> ::String

Parameter

value (::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}

Returns

(::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

def forwarding_rule_target() -> ::Google::Cloud::NetworkManagement::V1::Endpoint::ForwardingRuleTarget

Returns

(::Google::Cloud::NetworkManagement::V1::Endpoint::ForwardingRuleTarget) — Output only. Specifies the type of the target of the forwarding rule.

#fqdn

def fqdn() -> ::String

Returns

(::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.

#fqdn=

def fqdn=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#gke_master_cluster

def gke_master_cluster() -> ::String

Returns

(::String) — A cluster URI for Google Kubernetes Engine cluster control plane.

#gke_master_cluster=

def gke_master_cluster=(value) -> ::String

Parameter

value (::String) — A cluster URI for Google Kubernetes Engine cluster control plane.

Returns

(::String) — A cluster URI for Google Kubernetes Engine cluster control plane.

#instance

def instance() -> ::String

Returns

(::String) — A Compute Engine instance URI.

#instance=

def instance=(value) -> ::String

Parameter

value (::String) — A Compute Engine instance URI.

Returns

(::String) — A Compute Engine instance URI.

#ip_address

def ip_address() -> ::String

Returns

(::String) — The IP address of the endpoint, which can be an external or internal IP.

#ip_address=

def ip_address=(value) -> ::String

Parameter

value (::String) — The IP address of the endpoint, which can be an external or internal IP.

Returns

(::String) — The IP address of the endpoint, which can be an external or internal IP.

#load_balancer_id

def load_balancer_id() -> ::String

Returns

(::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

def load_balancer_type() -> ::Google::Cloud::NetworkManagement::V1::LoadBalancerType

Returns

(::Google::Cloud::NetworkManagement::V1::LoadBalancerType) — Output only. Type of the load balancer the forwarding rule points to.

#network

def network() -> ::String

Returns

(::String) — A Compute Engine network URI.

#network=

def network=(value) -> ::String

Parameter

value (::String) — A Compute Engine network URI.

Returns

(::String) — A Compute Engine network URI.

#network_type

def network_type() -> ::Google::Cloud::NetworkManagement::V1::Endpoint::NetworkType

Returns

(::Google::Cloud::NetworkManagement::V1::Endpoint::NetworkType) — Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.

#network_type=

def network_type=(value) -> ::Google::Cloud::NetworkManagement::V1::Endpoint::NetworkType

Parameter

value (::Google::Cloud::NetworkManagement::V1::Endpoint::NetworkType) — 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

(::Google::Cloud::NetworkManagement::V1::Endpoint::NetworkType) — Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.

#port

def port() -> ::Integer

Returns

(::Integer) — The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.

#port=

def port=(value) -> ::Integer

Parameter

value (::Integer) — The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.

Returns

(::Integer) — The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.

#project_id

def project_id() -> ::String

Returns

(::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.

#project_id=

def project_id=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#redis_cluster

def redis_cluster() -> ::String

Returns

(::String) — A Redis Cluster URI.

#redis_cluster=

def redis_cluster=(value) -> ::String

Parameter

value (::String) — A Redis Cluster URI.

Returns

(::String) — A Redis Cluster URI.

#redis_instance

def redis_instance() -> ::String

Returns

(::String) — A Redis Instance URI.

#redis_instance=

def redis_instance=(value) -> ::String

Parameter

value (::String) — A Redis Instance URI.

Returns

(::String) — A Redis Instance URI.