Network Services V1 API - Class Google::Cloud::NetworkServices::V1::Gateway (v2.2.0)

Reference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::Gateway.

Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#addresses

def addresses() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated

    This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.

#addresses=

def addresses=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated

    This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.

Returns
  • (::Array<::String>) — Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated

    This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.

#certificate_urls

def certificate_urls() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.

#certificate_urls=

def certificate_urls=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
Returns
  • (::Array<::String>) — Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. A free-text description of the resource. Max length 1024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A free-text description of the resource. Max length 1024 characters.
Returns
  • (::String) — Optional. A free-text description of the resource. Max length 1024 characters.

#envoy_headers

def envoy_headers() -> ::Google::Cloud::NetworkServices::V1::EnvoyHeaders
Returns

#envoy_headers=

def envoy_headers=(value) -> ::Google::Cloud::NetworkServices::V1::EnvoyHeaders
Parameter
Returns

#gateway_security_policy

def gateway_security_policy() -> ::String
Returns
  • (::String) — Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections.

    For example: projects/*/locations/*/gatewaySecurityPolicies/swg-policy.

    This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.

#gateway_security_policy=

def gateway_security_policy=(value) -> ::String
Parameter
  • value (::String) — Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections.

    For example: projects/*/locations/*/gatewaySecurityPolicies/swg-policy.

    This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.

Returns
  • (::String) — Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections.

    For example: projects/*/locations/*/gatewaySecurityPolicies/swg-policy.

    This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.

#ip_version

def ip_version() -> ::Google::Cloud::NetworkServices::V1::Gateway::IpVersion
Returns

#ip_version=

def ip_version=(value) -> ::Google::Cloud::NetworkServices::V1::Gateway::IpVersion
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the Gateway resource.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the Gateway resource.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the Gateway resource.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/<gateway_name>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/<gateway_name>.
Returns
  • (::String) — Identifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/<gateway_name>.

#network

def network() -> ::String
Returns
  • (::String) — Optional. The relative resource name identifying the VPC network that is using this configuration. For example: projects/*/global/networks/network-1.

    Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.

#network=

def network=(value) -> ::String
Parameter
  • value (::String) — Optional. The relative resource name identifying the VPC network that is using this configuration. For example: projects/*/global/networks/network-1.

    Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.

Returns
  • (::String) — Optional. The relative resource name identifying the VPC network that is using this configuration. For example: projects/*/global/networks/network-1.

    Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.

#ports

def ports() -> ::Array<::Integer>
Returns
  • (::Array<::Integer>) — Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.

#ports=

def ports=(value) -> ::Array<::Integer>
Parameter
  • value (::Array<::Integer>) — Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.
Returns
  • (::Array<::Integer>) — Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.

#routing_mode

def routing_mode() -> ::Google::Cloud::NetworkServices::V1::Gateway::RoutingMode
Returns

#routing_mode=

def routing_mode=(value) -> ::Google::Cloud::NetworkServices::V1::Gateway::RoutingMode
Parameter
Returns

#scope

def scope() -> ::String
Returns
  • (::String) — Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single configuration to the proxy/load balancer.

    Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

#scope=

def scope=(value) -> ::String
Parameter
  • value (::String) — Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single configuration to the proxy/load balancer.

    Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

Returns
  • (::String) — Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single configuration to the proxy/load balancer.

    Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

#self_link

def self_link() -> ::String
Returns
  • (::String) — Output only. Server-defined URL of this resource

#server_tls_policy

def server_tls_policy() -> ::String
Returns
  • (::String) — Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

#server_tls_policy=

def server_tls_policy=(value) -> ::String
Parameter
  • value (::String) — Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
Returns
  • (::String) — Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

#subnetwork

def subnetwork() -> ::String
Returns
  • (::String) — Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: projects/*/regions/us-central1/subnetworks/network-1

    Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".

#subnetwork=

def subnetwork=(value) -> ::String
Parameter
  • value (::String) — Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: projects/*/regions/us-central1/subnetworks/network-1

    Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".

Returns
  • (::String) — Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: projects/*/regions/us-central1/subnetworks/network-1

    Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".

#type

def type() -> ::Google::Cloud::NetworkServices::V1::Gateway::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::NetworkServices::V1::Gateway::Type
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns