Class: Google::Cloud::NetworkServices::V1::Gateway

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/networkservices/v1/gateway.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.

Defined Under Namespace

Modules: IpVersion, RoutingMode, Type Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#addresses ⇒ ::Array<::String>

Returns 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.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#certificate_urls ⇒ ::Array<::String>

Returns 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'.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when the resource was created.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#description ⇒ ::String

Returns 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.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#envoy_headers ⇒ ::Google::Cloud::NetworkServices::V1::EnvoyHeaders

Returns 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.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#gateway_security_policy ⇒ ::String

Returns 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'.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#ip_version ⇒ ::Google::Cloud::NetworkServices::V1::Gateway::IpVersion

Returns Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#name ⇒ ::String

Returns 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>.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#network ⇒ ::String

Returns 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'.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#ports ⇒ ::Array<::Integer>

Returns 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.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#routing_mode ⇒ ::Google::Cloud::NetworkServices::V1::Gateway::RoutingMode

Returns 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.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#scope ⇒ ::String

Returns 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.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#self_link ⇒ ::String (readonly)

Returns Output only. Server-defined URL of this resource.

Returns:

  • (::String) —

    Output only. Server-defined URL of this resource



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#server_tls_policy ⇒ ::String

Returns 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.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#subnetwork ⇒ ::String

Returns 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".



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#type ⇒ ::Google::Cloud::NetworkServices::V1::Gateway::Type

Returns Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when the resource was updated.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/networkservices/v1/gateway.rb', line 124

class Gateway
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the customer-managed gateway.
  # Possible values are:
  # * OPEN_MESH
  # * SECURE_WEB_GATEWAY
  module Type
    # The type of the customer managed gateway is unspecified.
    TYPE_UNSPECIFIED = 0

    # The type of the customer managed gateway is TrafficDirector Open
    # Mesh.
    OPEN_MESH = 1

    # The type of the customer managed gateway is SecureWebGateway (SWG).
    SECURE_WEB_GATEWAY = 2
  end

  # The types of IP version for the gateway.
  # Possible values are:
  # * IPV4
  # * IPV6
  module IpVersion
    # The type when IP version is not specified. Defaults to IPV4.
    IP_VERSION_UNSPECIFIED = 0

    # The type for IP version 4.
    IPV4 = 1

    # The type for IP version 6.
    IPV6 = 2
  end

  # The routing mode of the Gateway, to determine how the Gateway routes
  # traffic. Today, this field only applies to Gateways of type
  # SECURE_WEB_GATEWAY. Possible values are:
  # * EXPLICIT_ROUTING_MODE
  # * NEXT_HOP_ROUTING_MODE
  module RoutingMode
    # The routing mode is explicit; clients are configured to send
    # traffic through the gateway. This is the default routing mode.
    EXPLICIT_ROUTING_MODE = 0

    # The routing mode is next-hop. Clients are unaware of the gateway,
    # and a route (advanced route or other route type)
    # can be configured to direct traffic from client to gateway.
    # The gateway then acts as a next-hop to the destination.
    NEXT_HOP_ROUTING_MODE = 1
  end
end