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

Class Squash

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.filter.http.squash.v2.Squash
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SquashOrBuilder, Serializable
public final class Squash extends com.google.protobuf.GeneratedMessageV3 implements SquashOrBuilder
 [#next-free-field: 6]
Protobuf type envoy.config.filter.http.squash.v2.Squash
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Squash.Builder
    [#next-free-field: 6]

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ATTACHMENT_POLL_PERIOD_FIELD_NUMBER
     
    static final int
    ATTACHMENT_TEMPLATE_FIELD_NUMBER
     
    static final int
    ATTACHMENT_TIMEOUT_FIELD_NUMBER
     
    static final int
    CLUSTER_FIELD_NUMBER
     
    static final int
    REQUEST_TIMEOUT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    static Squash
    getDefaultInstance()
     
    Squash
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Squash>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    boolean
    hasRequestTimeout()
    The timeout for individual requests sent to the Squash cluster.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Squash.Builder
    newBuilder()
     
    static Squash.Builder
    newBuilder(Squash prototype)
     
    Squash.Builder
    newBuilderForType()
     
    protected Squash.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Squash
    parseDelimitedFrom(InputStream input)
     
    static Squash
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Squash
    parseFrom(byte[] data)
     
    static Squash
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Squash
    parseFrom(com.google.protobuf.ByteString data)
     
    static Squash
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Squash
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Squash
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Squash
    parseFrom(InputStream input)
     
    static Squash
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Squash
    parseFrom(ByteBuffer data)
     
    static Squash
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Squash>
    parser()
     
    Squash.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • CLUSTER_FIELD_NUMBER

      public static final int CLUSTER_FIELD_NUMBER
      See Also:

    • ATTACHMENT_TEMPLATE_FIELD_NUMBER

      public static final int ATTACHMENT_TEMPLATE_FIELD_NUMBER
      See Also:

    • REQUEST_TIMEOUT_FIELD_NUMBER

      public static final int REQUEST_TIMEOUT_FIELD_NUMBER
      See Also:

    • ATTACHMENT_TIMEOUT_FIELD_NUMBER

      public static final int ATTACHMENT_TIMEOUT_FIELD_NUMBER
      See Also:

    • ATTACHMENT_POLL_PERIOD_FIELD_NUMBER

      public static final int ATTACHMENT_POLL_PERIOD_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getCluster

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

    • getClusterBytes

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

    • hasAttachmentTemplate

      public 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;
      Specified by:
      hasAttachmentTemplate in interface SquashOrBuilder
      Returns:
      Whether the attachmentTemplate field is set.

    • getAttachmentTemplate

      public 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;
      Specified by:
      getAttachmentTemplate in interface SquashOrBuilder
      Returns:
      The attachmentTemplate.

    • getAttachmentTemplateOrBuilder

      public 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;
      Specified by:
      getAttachmentTemplateOrBuilder in interface SquashOrBuilder

    • hasRequestTimeout

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

    • getRequestTimeout

      public 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;
      Specified by:
      getRequestTimeout in interface SquashOrBuilder
      Returns:
      The requestTimeout.

    • getRequestTimeoutOrBuilder

      public 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;
      Specified by:
      getRequestTimeoutOrBuilder in interface SquashOrBuilder

    • hasAttachmentTimeout

      public 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;
      Specified by:
      hasAttachmentTimeout in interface SquashOrBuilder
      Returns:
      Whether the attachmentTimeout field is set.

    • getAttachmentTimeout

      public 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;
      Specified by:
      getAttachmentTimeout in interface SquashOrBuilder
      Returns:
      The attachmentTimeout.

    • getAttachmentTimeoutOrBuilder

      public 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;
      Specified by:
      getAttachmentTimeoutOrBuilder in interface SquashOrBuilder

    • hasAttachmentPollPeriod

      public 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;
      Specified by:
      hasAttachmentPollPeriod in interface SquashOrBuilder
      Returns:
      Whether the attachmentPollPeriod field is set.

    • getAttachmentPollPeriod

      public 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;
      Specified by:
      getAttachmentPollPeriod in interface SquashOrBuilder
      Returns:
      The attachmentPollPeriod.

    • getAttachmentPollPeriodOrBuilder

      public 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;
      Specified by:
      getAttachmentPollPeriodOrBuilder in interface SquashOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Squash parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Squash parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Squash parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Squash parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Squash parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Squash parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Squash parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Squash parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Squash parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Squash parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Squash parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Squash parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Squash.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Squash.Builder newBuilder()

    • newBuilder

      public static Squash.Builder newBuilder(Squash prototype)

    • toBuilder

      public Squash.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Squash.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Squash getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Squash> parser()

    • getParserForType

      public com.google.protobuf.Parser<Squash> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Squash getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder