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. Next id: 32

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Gateway

Returns a new instance of Gateway.



720
721
722
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 720

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>) 


615
616
617
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 615

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>) 


622
623
624
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 622

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) 


627
628
629
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 627

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) 


632
633
634
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 632

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) 


639
640
641
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 639

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) 


647
648
649
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 647

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) 


653
654
655
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 653

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>) 


658
659
660
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 658

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


664
665
666
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 664

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) 


671
672
673
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 671

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 1 port. 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>) 


679
680
681
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 679

def ports
  @ports
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 coniguration 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) 


688
689
690
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 688

def scope
  @scope
end

#self_link ⇒ String

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

Returns:

  • (String) 


693
694
695
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 693

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) 


699
700
701
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 699

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) 


707
708
709
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 707

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) 


713
714
715
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 713

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


718
719
720
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 718

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 725

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)
  @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