Class: Google::Cloud::NetworkServices::V1::ExtensionChain

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/networkservices/v1/dep.rb

Overview

A single extension chain wrapper that contains the match conditions and extensions to execute.

Defined Under Namespace

Classes: Extension, MatchCondition

Instance Attribute Summary collapse

Instance Attribute Details

#extensions ⇒ ::Array<::Google::Cloud::NetworkServices::V1::ExtensionChain::Extension>

Returns Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for LbTrafficExtension resource. LbRouteExtension chains are limited to 1 extension per extension chain.

Returns:

  • (::Array<::Google::Cloud::NetworkServices::V1::ExtensionChain::Extension>) —

    Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for LbTrafficExtension resource. LbRouteExtension chains are limited to 1 extension per extension chain.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/networkservices/v1/dep.rb', line 44

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

  # Conditions under which this chain is invoked for a request.
  # @!attribute [rw] cel_expression
  #   @return [::String]
  #     Required. A Common Expression Language (CEL) expression that is used to
  #     match requests for which the extension chain is executed.
  #
  #     For more information, see [CEL matcher language
  #     reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
  class MatchCondition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A single extension in the chain to execute for the matching request.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name for this extension.
  #     The name is logged as part of the HTTP request logs.
  #     The name must conform with RFC-1034, is restricted to lower-cased
  #     letters, numbers and hyphens, and can have a maximum length of 63
  #     characters. Additionally, the first character must be a letter and the
  #     last a letter or a number.
  # @!attribute [rw] authority
  #   @return [::String]
  #     Optional. The `:authority` header in the gRPC request sent from Envoy
  #     to the extension service.
  #     Required for Callout extensions.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The reference to the service that runs the extension.
  #
  #     Currently only callout extensions are supported here.
  #
  #     To configure a callout extension, `service` must be a fully-qualified
  #     reference
  #     to a [backend
  #     service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
  #     in the format:
  #     `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`
  #     or
  #     `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.
  # @!attribute [rw] supported_events
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::EventType>]
  #     Optional. A set of events during request or response processing for which
  #     this extension is called. This field is required for the
  #     `LbTrafficExtension` resource. It must not be set for the
  #     `LbRouteExtension` resource.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Specifies the timeout for each individual message on the
  #     stream. The timeout must be between 10-1000 milliseconds. Required for
  #     Callout extensions.
  # @!attribute [rw] fail_open
  #   @return [::Boolean]
  #     Optional. Determines how the proxy behaves if the call to the extension
  #     fails or times out.
  #
  #     When set to `TRUE`, request or response processing continues without
  #     error. Any subsequent extensions in the extension chain are also
  #     executed. When set to `FALSE` or the default setting of `FALSE` is used,
  #     one of the following happens:
  #
  #     * If response headers have not been delivered to the downstream client,
  #     a generic 500 error is returned to the client. The error response can be
  #     tailored by configuring a custom error response in the load balancer.
  #
  #     * If response headers have been delivered, then the HTTP stream to the
  #     downstream client is reset.
  # @!attribute [rw] forward_headers
  #   @return [::Array<::String>]
  #     Optional. List of the HTTP headers to forward to the extension
  #     (from the client or backend). If omitted, all headers are sent.
  #     Each element is a string indicating the header name.
  class Extension
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#match_condition ⇒ ::Google::Cloud::NetworkServices::V1::ExtensionChain::MatchCondition

Returns Required. Conditions under which this chain is invoked for a request.

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/networkservices/v1/dep.rb', line 44

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

  # Conditions under which this chain is invoked for a request.
  # @!attribute [rw] cel_expression
  #   @return [::String]
  #     Required. A Common Expression Language (CEL) expression that is used to
  #     match requests for which the extension chain is executed.
  #
  #     For more information, see [CEL matcher language
  #     reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
  class MatchCondition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A single extension in the chain to execute for the matching request.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name for this extension.
  #     The name is logged as part of the HTTP request logs.
  #     The name must conform with RFC-1034, is restricted to lower-cased
  #     letters, numbers and hyphens, and can have a maximum length of 63
  #     characters. Additionally, the first character must be a letter and the
  #     last a letter or a number.
  # @!attribute [rw] authority
  #   @return [::String]
  #     Optional. The `:authority` header in the gRPC request sent from Envoy
  #     to the extension service.
  #     Required for Callout extensions.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The reference to the service that runs the extension.
  #
  #     Currently only callout extensions are supported here.
  #
  #     To configure a callout extension, `service` must be a fully-qualified
  #     reference
  #     to a [backend
  #     service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
  #     in the format:
  #     `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`
  #     or
  #     `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.
  # @!attribute [rw] supported_events
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::EventType>]
  #     Optional. A set of events during request or response processing for which
  #     this extension is called. This field is required for the
  #     `LbTrafficExtension` resource. It must not be set for the
  #     `LbRouteExtension` resource.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Specifies the timeout for each individual message on the
  #     stream. The timeout must be between 10-1000 milliseconds. Required for
  #     Callout extensions.
  # @!attribute [rw] fail_open
  #   @return [::Boolean]
  #     Optional. Determines how the proxy behaves if the call to the extension
  #     fails or times out.
  #
  #     When set to `TRUE`, request or response processing continues without
  #     error. Any subsequent extensions in the extension chain are also
  #     executed. When set to `FALSE` or the default setting of `FALSE` is used,
  #     one of the following happens:
  #
  #     * If response headers have not been delivered to the downstream client,
  #     a generic 500 error is returned to the client. The error response can be
  #     tailored by configuring a custom error response in the load balancer.
  #
  #     * If response headers have been delivered, then the HTTP stream to the
  #     downstream client is reset.
  # @!attribute [rw] forward_headers
  #   @return [::Array<::String>]
  #     Optional. List of the HTTP headers to forward to the extension
  #     (from the client or backend). If omitted, all headers are sent.
  #     Each element is a string indicating the header name.
  class Extension
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Required. The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.

Returns:

  • (::String) —

    Required. The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'proto_docs/google/cloud/networkservices/v1/dep.rb', line 44

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

  # Conditions under which this chain is invoked for a request.
  # @!attribute [rw] cel_expression
  #   @return [::String]
  #     Required. A Common Expression Language (CEL) expression that is used to
  #     match requests for which the extension chain is executed.
  #
  #     For more information, see [CEL matcher language
  #     reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
  class MatchCondition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A single extension in the chain to execute for the matching request.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name for this extension.
  #     The name is logged as part of the HTTP request logs.
  #     The name must conform with RFC-1034, is restricted to lower-cased
  #     letters, numbers and hyphens, and can have a maximum length of 63
  #     characters. Additionally, the first character must be a letter and the
  #     last a letter or a number.
  # @!attribute [rw] authority
  #   @return [::String]
  #     Optional. The `:authority` header in the gRPC request sent from Envoy
  #     to the extension service.
  #     Required for Callout extensions.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The reference to the service that runs the extension.
  #
  #     Currently only callout extensions are supported here.
  #
  #     To configure a callout extension, `service` must be a fully-qualified
  #     reference
  #     to a [backend
  #     service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
  #     in the format:
  #     `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`
  #     or
  #     `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.
  # @!attribute [rw] supported_events
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::EventType>]
  #     Optional. A set of events during request or response processing for which
  #     this extension is called. This field is required for the
  #     `LbTrafficExtension` resource. It must not be set for the
  #     `LbRouteExtension` resource.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Specifies the timeout for each individual message on the
  #     stream. The timeout must be between 10-1000 milliseconds. Required for
  #     Callout extensions.
  # @!attribute [rw] fail_open
  #   @return [::Boolean]
  #     Optional. Determines how the proxy behaves if the call to the extension
  #     fails or times out.
  #
  #     When set to `TRUE`, request or response processing continues without
  #     error. Any subsequent extensions in the extension chain are also
  #     executed. When set to `FALSE` or the default setting of `FALSE` is used,
  #     one of the following happens:
  #
  #     * If response headers have not been delivered to the downstream client,
  #     a generic 500 error is returned to the client. The error response can be
  #     tailored by configuring a custom error response in the load balancer.
  #
  #     * If response headers have been delivered, then the HTTP stream to the
  #     downstream client is reset.
  # @!attribute [rw] forward_headers
  #   @return [::Array<::String>]
  #     Optional. List of the HTTP headers to forward to the extension
  #     (from the client or backend). If omitted, all headers are sent.
  #     Each element is a string indicating the header name.
  class Extension
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end