Interface ExtensionChain.ExtensionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExtensionChain.Extension, ExtensionChain.Extension.Builder
Enclosing class:
ExtensionChain

public static interface ExtensionChain.ExtensionOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getName

      String getName()
       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.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       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.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for name.
    • getAuthority

      String getAuthority()
       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.
       
      string authority = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The authority.
    • getAuthorityBytes

      com.google.protobuf.ByteString getAuthorityBytes()
       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.
       
      string authority = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for authority.
    • getService

      String getService()
       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.
       
      string service = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The service.
    • getServiceBytes

      com.google.protobuf.ByteString getServiceBytes()
       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.
       
      string service = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for service.
    • getSupportedEventsList

      List<EventType> getSupportedEventsList()
       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.
       
      repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the supportedEvents.
    • getSupportedEventsCount

      int getSupportedEventsCount()
       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.
       
      repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of supportedEvents.
    • getSupportedEvents

      EventType getSupportedEvents(int index)
       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.
       
      repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The supportedEvents at the given index.
    • getSupportedEventsValueList

      List<Integer> getSupportedEventsValueList()
       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.
       
      repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the enum numeric values on the wire for supportedEvents.
    • getSupportedEventsValue

      int getSupportedEventsValue(int index)
       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.
       
      repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of supportedEvents at the given index.
    • hasTimeout

      boolean hasTimeout()
       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.
       
      .google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the timeout field is set.
    • getTimeout

      com.google.protobuf.Duration getTimeout()
       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.
       
      .google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The timeout.
    • getTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       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.
       
      .google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
    • getFailOpen

      boolean getFailOpen()
       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.
       
      bool fail_open = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The failOpen.
    • getForwardHeadersList

      List<String> getForwardHeadersList()
       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.
       
      repeated string forward_headers = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the forwardHeaders.
    • getForwardHeadersCount

      int getForwardHeadersCount()
       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.
       
      repeated string forward_headers = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of forwardHeaders.
    • getForwardHeaders

      String getForwardHeaders(int index)
       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.
       
      repeated string forward_headers = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The forwardHeaders at the given index.
    • getForwardHeadersBytes

      com.google.protobuf.ByteString getForwardHeadersBytes(int index)
       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.
       
      repeated string forward_headers = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the forwardHeaders at the given index.
    • hasMetadata

      boolean hasMetadata()
       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.
       
      .google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the metadata field is set.
    • getMetadata

      com.google.protobuf.Struct getMetadata()
       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.
       
      .google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The metadata.
    • getMetadataOrBuilder

      com.google.protobuf.StructOrBuilder getMetadataOrBuilder()
       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.
       
      .google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];