Class: Google::Apis::NetworkservicesV1::GrpcRoute

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

GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GrpcRoute

Returns a new instance of GrpcRoute.



856
857
858
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 856

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

Returns:

  • (String) 


783
784
785
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 783

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) 


788
789
790
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 788

def description
  @description
end

#gateways ⇒ Array<String>

Optional. Gateways defines a list of gateways this GrpcRoute 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

Returns:

  • (Array<String>) 


796
797
798
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 796

def gateways
  @gateways
end

#hostnames ⇒ Array<String>

Required. Service hostnames with an optional port for which this route describes traffic. Format: [:] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: - 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 Gateway 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 route, it is not possible to associate two routes both with *.bar.com or both with bar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service"). Corresponds to the JSON property hostnames

Returns:

  • (Array<String>) 


819
820
821
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 819

def hostnames
  @hostnames
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


824
825
826
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 824

def labels
  @labels
end

#meshes ⇒ Array<String>

Optional. Meshes defines a list of meshes this GrpcRoute 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/ Corresponds to the JSON property meshes

Returns:

  • (Array<String>) 


831
832
833
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 831

def meshes
  @meshes
end

#name ⇒ String

Identifier. Name of the GrpcRoute resource. It matches pattern projects/*/ locations/global/grpcRoutes/ Corresponds to the JSON property name

Returns:

  • (String) 


837
838
839
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 837

def name
  @name
end

#rules ⇒ Array<Google::Apis::NetworkservicesV1::GrpcRouteRouteRule>

Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied. Corresponds to the JSON property rules

Returns:



844
845
846
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 844

def rules
  @rules
end

#self_link ⇒ String

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

Returns:

  • (String) 


849
850
851
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 849

def self_link
  @self_link
end

#update_time ⇒ String

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

Returns:

  • (String) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 861

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