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 and LbEdgeExtension 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 and LbEdgeExtension chains are limited to 1 extension per extension chain.



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
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
 
# File 'proto_docs/google/cloud/networkservices/v1/dep.rb', line 45

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.
  #
  #     This field is not supported for plugin extensions. Setting it results in
  #     a validation error.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The reference to the service that runs the extension.
  #
  #     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}`.
  #
  #     To configure a plugin extension, `service` must be a reference
  #     to a [`WasmPlugin`
  #     resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins)
  #     in the format:
  #     `projects/{project}/locations/{location}/wasmPlugins/{plugin}`
  #     or
  #     `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`.
  #
  #     Plugin extensions are currently supported for the
  #     `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension`
  #     resources.
  # @!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.
  #
  #     For the `LbTrafficExtension` resource, this field is required.
  #
  #     For the `LbRouteExtension` resource, this field is optional. If
  #     unspecified, `REQUEST_HEADERS` event is assumed as supported.
  #
  #     For the `LbEdgeExtension` resource, this field is required and must only
  #     contain `REQUEST_HEADERS` event.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Specifies the timeout for each individual message on the
  #     stream. The timeout must be between `10`-`10000` milliseconds. Required
  #     for callout extensions.
  #
  #     This field is not supported for plugin extensions. Setting it results in
  #     a validation error.
  # @!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.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. The metadata provided here is included as part of the
  #     `metadata_context` (of type `google.protobuf.Struct`) in the
  #     `ProcessingRequest` message sent to the extension server.
  #
  #     The metadata is available under the namespace
  #     `com.google.<extension_type>.<resource_name>.<extension_chain_name>.<extension_name>`.
  #     For example:
  #     `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`.
  #
  #     The following variables are supported in the metadata:
  #
  #     `{forwarding_rule_id}` - substituted with the forwarding rule's fully
  #       qualified resource name.
  #
  #     This field must not be set for plugin extensions. Setting it results in
  #     a validation error.
  #
  #     You can set metadata at either the resource level or the extension level.
  #     The extension level metadata is recommended because you can pass a
  #     different set of metadata through each extension to the backend.
  #
  #     This field is subject to following limitations:
  #
  #     * The total size of the metadata must be less than 1KiB.
  #     * The total number of keys in the metadata must be less than 16.
  #     * The length of each key must be less than 64 characters.
  #     * The length of each value must be less than 1024 characters.
  #     * All values must be strings.
  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:



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
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
 
# File 'proto_docs/google/cloud/networkservices/v1/dep.rb', line 45

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.
  #
  #     This field is not supported for plugin extensions. Setting it results in
  #     a validation error.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The reference to the service that runs the extension.
  #
  #     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}`.
  #
  #     To configure a plugin extension, `service` must be a reference
  #     to a [`WasmPlugin`
  #     resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins)
  #     in the format:
  #     `projects/{project}/locations/{location}/wasmPlugins/{plugin}`
  #     or
  #     `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`.
  #
  #     Plugin extensions are currently supported for the
  #     `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension`
  #     resources.
  # @!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.
  #
  #     For the `LbTrafficExtension` resource, this field is required.
  #
  #     For the `LbRouteExtension` resource, this field is optional. If
  #     unspecified, `REQUEST_HEADERS` event is assumed as supported.
  #
  #     For the `LbEdgeExtension` resource, this field is required and must only
  #     contain `REQUEST_HEADERS` event.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Specifies the timeout for each individual message on the
  #     stream. The timeout must be between `10`-`10000` milliseconds. Required
  #     for callout extensions.
  #
  #     This field is not supported for plugin extensions. Setting it results in
  #     a validation error.
  # @!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.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. The metadata provided here is included as part of the
  #     `metadata_context` (of type `google.protobuf.Struct`) in the
  #     `ProcessingRequest` message sent to the extension server.
  #
  #     The metadata is available under the namespace
  #     `com.google.<extension_type>.<resource_name>.<extension_chain_name>.<extension_name>`.
  #     For example:
  #     `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`.
  #
  #     The following variables are supported in the metadata:
  #
  #     `{forwarding_rule_id}` - substituted with the forwarding rule's fully
  #       qualified resource name.
  #
  #     This field must not be set for plugin extensions. Setting it results in
  #     a validation error.
  #
  #     You can set metadata at either the resource level or the extension level.
  #     The extension level metadata is recommended because you can pass a
  #     different set of metadata through each extension to the backend.
  #
  #     This field is subject to following limitations:
  #
  #     * The total size of the metadata must be less than 1KiB.
  #     * The total number of keys in the metadata must be less than 16.
  #     * The length of each key must be less than 64 characters.
  #     * The length of each value must be less than 1024 characters.
  #     * All values must be strings.
  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.



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
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
 
# File 'proto_docs/google/cloud/networkservices/v1/dep.rb', line 45

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.
  #
  #     This field is not supported for plugin extensions. Setting it results in
  #     a validation error.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The reference to the service that runs the extension.
  #
  #     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}`.
  #
  #     To configure a plugin extension, `service` must be a reference
  #     to a [`WasmPlugin`
  #     resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins)
  #     in the format:
  #     `projects/{project}/locations/{location}/wasmPlugins/{plugin}`
  #     or
  #     `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`.
  #
  #     Plugin extensions are currently supported for the
  #     `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension`
  #     resources.
  # @!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.
  #
  #     For the `LbTrafficExtension` resource, this field is required.
  #
  #     For the `LbRouteExtension` resource, this field is optional. If
  #     unspecified, `REQUEST_HEADERS` event is assumed as supported.
  #
  #     For the `LbEdgeExtension` resource, this field is required and must only
  #     contain `REQUEST_HEADERS` event.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Specifies the timeout for each individual message on the
  #     stream. The timeout must be between `10`-`10000` milliseconds. Required
  #     for callout extensions.
  #
  #     This field is not supported for plugin extensions. Setting it results in
  #     a validation error.
  # @!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.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. The metadata provided here is included as part of the
  #     `metadata_context` (of type `google.protobuf.Struct`) in the
  #     `ProcessingRequest` message sent to the extension server.
  #
  #     The metadata is available under the namespace
  #     `com.google.<extension_type>.<resource_name>.<extension_chain_name>.<extension_name>`.
  #     For example:
  #     `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`.
  #
  #     The following variables are supported in the metadata:
  #
  #     `{forwarding_rule_id}` - substituted with the forwarding rule's fully
  #       qualified resource name.
  #
  #     This field must not be set for plugin extensions. Setting it results in
  #     a validation error.
  #
  #     You can set metadata at either the resource level or the extension level.
  #     The extension level metadata is recommended because you can pass a
  #     different set of metadata through each extension to the backend.
  #
  #     This field is subject to following limitations:
  #
  #     * The total size of the metadata must be less than 1KiB.
  #     * The total number of keys in the metadata must be less than 16.
  #     * The length of each key must be less than 64 characters.
  #     * The length of each value must be less than 1024 characters.
  #     * All values must be strings.
  class Extension
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end