Package io.envoyproxy.envoy.config.filter.http.squash.v2

Interface SquashOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Squash, Squash.Builder
public interface SquashOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    getAttachmentPollPeriod()
    Amount of time to poll for the status of the attachment object in the Squash server (to check if has been attached).
    com.google.protobuf.DurationOrBuilder
    getAttachmentPollPeriodOrBuilder()
    Amount of time to poll for the status of the attachment object in the Squash server (to check if has been attached).
    com.google.protobuf.Struct
    getAttachmentTemplate()
    When the filter requests the Squash server to create a DebugAttachment, it will use this structure as template for the body of the request.
    com.google.protobuf.StructOrBuilder
    getAttachmentTemplateOrBuilder()
    When the filter requests the Squash server to create a DebugAttachment, it will use this structure as template for the body of the request.
    com.google.protobuf.Duration
    getAttachmentTimeout()
    The total timeout Squash will delay a request and wait for it to be attached.
    com.google.protobuf.DurationOrBuilder
    getAttachmentTimeoutOrBuilder()
    The total timeout Squash will delay a request and wait for it to be attached.
    String
    getCluster()
    The name of the cluster that hosts the Squash server.
    com.google.protobuf.ByteString
    getClusterBytes()
    The name of the cluster that hosts the Squash server.
    com.google.protobuf.Duration
    getRequestTimeout()
    The timeout for individual requests sent to the Squash cluster.
    com.google.protobuf.DurationOrBuilder
    getRequestTimeoutOrBuilder()
    The timeout for individual requests sent to the Squash cluster.
    boolean
    hasAttachmentPollPeriod()
    Amount of time to poll for the status of the attachment object in the Squash server (to check if has been attached).
    boolean
    hasAttachmentTemplate()
    When the filter requests the Squash server to create a DebugAttachment, it will use this structure as template for the body of the request.
    boolean
    hasAttachmentTimeout()
    The total timeout Squash will delay a request and wait for it to be attached.
    boolean
    hasRequestTimeout()
    The timeout for individual requests sent to the Squash cluster.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getCluster

      String getCluster()
       The name of the cluster that hosts the Squash server.
      string cluster = 1 [(.validate.rules) = { ... }
      Returns:
      The cluster.

    • getClusterBytes

      com.google.protobuf.ByteString getClusterBytes()
       The name of the cluster that hosts the Squash server.
      string cluster = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for cluster.

    • hasAttachmentTemplate

      boolean hasAttachmentTemplate()
       When the filter requests the Squash server to create a DebugAttachment, it will use this
 structure as template for the body of the request. It can contain reference to environment
 variables in the form of '{{ ENV_VAR_NAME }}'. These can be used to provide the Squash server
 with more information to find the process to attach the debugger to. For example, in a
 Istio/k8s environment, this will contain information on the pod:

 .. code-block:: json

  {
    "spec": {
      "attachment": {
        "pod": "{{ POD_NAME }}",
        "namespace": "{{ POD_NAMESPACE }}"
      },
      "match_request": true
    }
  }

 (where POD_NAME, POD_NAMESPACE are configured in the pod via the Downward API)
      .google.protobuf.Struct attachment_template = 2;
      Returns:
      Whether the attachmentTemplate field is set.

    • getAttachmentTemplate

      com.google.protobuf.Struct getAttachmentTemplate()
       When the filter requests the Squash server to create a DebugAttachment, it will use this
 structure as template for the body of the request. It can contain reference to environment
 variables in the form of '{{ ENV_VAR_NAME }}'. These can be used to provide the Squash server
 with more information to find the process to attach the debugger to. For example, in a
 Istio/k8s environment, this will contain information on the pod:

 .. code-block:: json

  {
    "spec": {
      "attachment": {
        "pod": "{{ POD_NAME }}",
        "namespace": "{{ POD_NAMESPACE }}"
      },
      "match_request": true
    }
  }

 (where POD_NAME, POD_NAMESPACE are configured in the pod via the Downward API)
      .google.protobuf.Struct attachment_template = 2;
      Returns:
      The attachmentTemplate.

    • getAttachmentTemplateOrBuilder

      com.google.protobuf.StructOrBuilder getAttachmentTemplateOrBuilder()
       When the filter requests the Squash server to create a DebugAttachment, it will use this
 structure as template for the body of the request. It can contain reference to environment
 variables in the form of '{{ ENV_VAR_NAME }}'. These can be used to provide the Squash server
 with more information to find the process to attach the debugger to. For example, in a
 Istio/k8s environment, this will contain information on the pod:

 .. code-block:: json

  {
    "spec": {
      "attachment": {
        "pod": "{{ POD_NAME }}",
        "namespace": "{{ POD_NAMESPACE }}"
      },
      "match_request": true
    }
  }

 (where POD_NAME, POD_NAMESPACE are configured in the pod via the Downward API)
      .google.protobuf.Struct attachment_template = 2;

    • hasRequestTimeout

      boolean hasRequestTimeout()
       The timeout for individual requests sent to the Squash cluster. Defaults to 1 second.
      .google.protobuf.Duration request_timeout = 3;
      Returns:
      Whether the requestTimeout field is set.

    • getRequestTimeout

      com.google.protobuf.Duration getRequestTimeout()
       The timeout for individual requests sent to the Squash cluster. Defaults to 1 second.
      .google.protobuf.Duration request_timeout = 3;
      Returns:
      The requestTimeout.

    • getRequestTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getRequestTimeoutOrBuilder()
       The timeout for individual requests sent to the Squash cluster. Defaults to 1 second.
      .google.protobuf.Duration request_timeout = 3;

    • hasAttachmentTimeout

      boolean hasAttachmentTimeout()
       The total timeout Squash will delay a request and wait for it to be attached. Defaults to 60
 seconds.
      .google.protobuf.Duration attachment_timeout = 4;
      Returns:
      Whether the attachmentTimeout field is set.

    • getAttachmentTimeout

      com.google.protobuf.Duration getAttachmentTimeout()
       The total timeout Squash will delay a request and wait for it to be attached. Defaults to 60
 seconds.
      .google.protobuf.Duration attachment_timeout = 4;
      Returns:
      The attachmentTimeout.

    • getAttachmentTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getAttachmentTimeoutOrBuilder()
       The total timeout Squash will delay a request and wait for it to be attached. Defaults to 60
 seconds.
      .google.protobuf.Duration attachment_timeout = 4;

    • hasAttachmentPollPeriod

      boolean hasAttachmentPollPeriod()
       Amount of time to poll for the status of the attachment object in the Squash server
 (to check if has been attached). Defaults to 1 second.
      .google.protobuf.Duration attachment_poll_period = 5;
      Returns:
      Whether the attachmentPollPeriod field is set.

    • getAttachmentPollPeriod

      com.google.protobuf.Duration getAttachmentPollPeriod()
       Amount of time to poll for the status of the attachment object in the Squash server
 (to check if has been attached). Defaults to 1 second.
      .google.protobuf.Duration attachment_poll_period = 5;
      Returns:
      The attachmentPollPeriod.

    • getAttachmentPollPeriodOrBuilder

      com.google.protobuf.DurationOrBuilder getAttachmentPollPeriodOrBuilder()
       Amount of time to poll for the status of the attachment object in the Squash server
 (to check if has been attached). Defaults to 1 second.
      .google.protobuf.Duration attachment_poll_period = 5;