Class: Google::Apis::NetworkservicesV1::Gateway

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/networkservices_v1/classes.rb,
lib/google/apis/networkservices_v1/representations.rb,
lib/google/apis/networkservices_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Gateway

Returns a new instance of Gateway.



934
935
936
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 934

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#addresses ⇒ 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. Corresponds to the JSON property addresses

Returns:

  • (Array<String>) 


822
823
824
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 822

def addresses
  @addresses
end

#certificate_urls ⇒ 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'. Corresponds to the JSON property certificateUrls

Returns:

  • (Array<String>) 


829
830
831
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 829

def certificate_urls
  @certificate_urls
end

#create_time ⇒ String

Output only. The timestamp when the resource was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


834
835
836
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 834

def create_time
  @create_time
end

#description ⇒ String

Optional. A free-text description of the resource. Max length 1024 characters. Corresponds to the JSON property description

Returns:

  • (String) 


839
840
841
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 839

def description
  @description
end

#envoy_headers ⇒ String

Optional. Determines if envoy will insert internal debug headers into upstream requests. Other Envoy headers may still be injected. By default, envoy will not insert any debug headers. Corresponds to the JSON property envoyHeaders

Returns:

  • (String) 


846
847
848
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 846

def envoy_headers
  @envoy_headers
end

#gateway_security_policy ⇒ 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'. Corresponds to the JSON property gatewaySecurityPolicy

Returns:

  • (String) 


854
855
856
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 854

def gateway_security_policy
  @gateway_security_policy
end

#ip_version ⇒ String

Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4. Corresponds to the JSON property ipVersion

Returns:

  • (String) 


860
861
862
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 860

def ip_version
  @ip_version
end

#labels ⇒ Hash<String,String>

Optional. Set of label tags associated with the Gateway resource. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


865
866
867
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 865

def labels
  @labels
end

#name ⇒ String

Identifier. Name of the Gateway resource. It matches pattern projects/*/ locations/*/gateways/. Corresponds to the JSON property name

Returns:

  • (String) 


871
872
873
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 871

def name
  @name
end

#network ⇒ 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'. Corresponds to the JSON property network

Returns:

  • (String) 


878
879
880
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 878

def network
  @network
end

#ports ⇒ Array<Fixnum>

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 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. Corresponds to the JSON property ports

Returns:

  • (Array<Fixnum>) 


886
887
888
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 886

def ports
  @ports
end

#routing_mode ⇒ String

Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. Corresponds to the JSON property routingMode

Returns:

  • (String) 


893
894
895
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 893

def routing_mode
  @routing_mode
end

#scope ⇒ 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. Corresponds to the JSON property scope

Returns:

  • (String) 


902
903
904
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 902

def scope
  @scope
end

#self_link ⇒ String

Output only. Server-defined URL of this resource Corresponds to the JSON property selfLink

Returns:

  • (String) 


907
908
909
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 907

def self_link
  @self_link
end

#server_tls_policy ⇒ String

Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. Corresponds to the JSON property serverTlsPolicy

Returns:

  • (String) 


913
914
915
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 913

def server_tls_policy
  @server_tls_policy
end

#subnetwork ⇒ 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". Corresponds to the JSON property subnetwork

Returns:

  • (String) 


921
922
923
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 921

def subnetwork
  @subnetwork
end

#type ⇒ String

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned. Corresponds to the JSON property type

Returns:

  • (String) 


927
928
929
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 927

def type
  @type
end

#update_time ⇒ String

Output only. The timestamp when the resource was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


932
933
934
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 932

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 939

def update!(**args)
  @addresses = args[:addresses] if args.key?(:addresses)
  @certificate_urls = args[:certificate_urls] if args.key?(:certificate_urls)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @envoy_headers = args[:envoy_headers] if args.key?(:envoy_headers)
  @gateway_security_policy = args[:gateway_security_policy] if args.key?(:gateway_security_policy)
  @ip_version = args[:ip_version] if args.key?(:ip_version)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @ports = args[:ports] if args.key?(:ports)
  @routing_mode = args[:routing_mode] if args.key?(:routing_mode)
  @scope = args[:scope] if args.key?(:scope)
  @self_link = args[:self_link] if args.key?(:self_link)
  @server_tls_policy = args[:server_tls_policy] if args.key?(:server_tls_policy)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @type = args[:type] if args.key?(:type)
  @update_time = args[:update_time] if args.key?(:update_time)
end