Class: Google::Apis::NetworkservicesV1::HttpRoute
- Inherits:
-
Object
- Object
- Google::Apis::NetworkservicesV1::HttpRoute
- 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
HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.
Instance Attribute Summary collapse
-
#create_time ⇒ String
Output only.
-
#description ⇒ String
Optional.
-
#gateways ⇒ Array<String>
Optional.
-
#hostnames ⇒ Array<String>
Required.
-
#labels ⇒ Hash<String,String>
Optional.
-
#meshes ⇒ Array<String>
Optional.
-
#name ⇒ String
Identifier.
-
#rules ⇒ Array<Google::Apis::NetworkservicesV1::HttpRouteRouteRule>
Required.
-
#self_link ⇒ String
Output only.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HttpRoute
constructor
A new instance of HttpRoute.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ HttpRoute
Returns a new instance of HttpRoute.
1314 1315 1316 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1314 def initialize(**args) update!(**args) end |
Instance Attribute Details
#create_time ⇒ String
Output only. The timestamp when the resource was created.
Corresponds to the JSON property createTime
1243 1244 1245 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1243 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
1248 1249 1250 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1248 def description @description end |
#gateways ⇒ Array<String>
Optional. Gateways defines a list of gateways this HttpRoute is attached to,
as one of the routing rules to route the requests served by the gateway. Each
gateway reference should match the pattern: projects/*/locations/global/
gateways/
Corresponds to the JSON property gateways
1256 1257 1258 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1256 def gateways @gateways end |
#hostnames ⇒ Array<String>
Required. Hostnames define a set of hosts that should match against the HTTP
host header to select a HttpRoute to process the request. Hostname is the
fully qualified domain name of a network host, as defined by RFC 1123 with the
exception that: - IPs are not allowed. - A hostname may be prefixed with a
wildcard label (*.
). The wildcard label must appear by itself as the first
label. Hostname can be "precise" which is a domain name without the
terminating dot of a network host (e.g. foo.example.com
) or "wildcard",
which is a domain name prefixed with a single wildcard label (e.g. *.example.
com
). Note that as per RFC1035 and RFC1123, a label must consist of lower
case alphanumeric characters or '-', and must start and end with an
alphanumeric character. No other punctuation is allowed. The routes associated
with a Mesh or Gateways must have unique hostnames. If you attempt to attach
multiple routes with conflicting hostnames, the configuration will be rejected.
For example, while it is acceptable for routes for the hostnames *.foo.bar.
com
and *.bar.com
to be associated with the same Mesh (or Gateways under
the same scope), it is not possible to associate two routes both with *.bar.
com
or both with bar.com
.
Corresponds to the JSON property hostnames
1277 1278 1279 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1277 def hostnames @hostnames end |
#labels ⇒ Hash<String,String>
Optional. Set of label tags associated with the HttpRoute resource.
Corresponds to the JSON property labels
1282 1283 1284 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1282 def labels @labels end |
#meshes ⇒ Array<String>
Optional. Meshes defines a list of meshes this HttpRoute is attached to, as
one of the routing rules to route the requests served by the mesh. Each mesh
reference should match the pattern: projects/*/locations/global/meshes/
The
attached Mesh should be of a type SIDECAR
Corresponds to the JSON property meshes
1290 1291 1292 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1290 def meshes @meshes end |
#name ⇒ String
Identifier. Name of the HttpRoute resource. It matches pattern projects/*/
locations/global/httpRoutes/http_route_name>
.
Corresponds to the JSON property name
1296 1297 1298 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1296 def name @name end |
#rules ⇒ Array<Google::Apis::NetworkservicesV1::HttpRouteRouteRule>
Required. Rules that define how traffic is routed and handled. Rules will be
matched sequentially based on the RouteMatch specified for the rule.
Corresponds to the JSON property rules
1302 1303 1304 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1302 def rules @rules end |
#self_link ⇒ String
Output only. Server-defined URL of this resource
Corresponds to the JSON property selfLink
1307 1308 1309 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1307 def self_link @self_link end |
#update_time ⇒ String
Output only. The timestamp when the resource was updated.
Corresponds to the JSON property updateTime
1312 1313 1314 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1312 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 |
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1319 def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @description = args[:description] if args.key?(:description) @gateways = args[:gateways] if args.key?(:gateways) @hostnames = args[:hostnames] if args.key?(:hostnames) @labels = args[:labels] if args.key?(:labels) @meshes = args[:meshes] if args.key?(:meshes) @name = args[:name] if args.key?(:name) @rules = args[:rules] if args.key?(:rules) @self_link = args[:self_link] if args.key?(:self_link) @update_time = args[:update_time] if args.key?(:update_time) end |