Squash.Builder (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>
    - - io.envoyproxy.envoy.extensions.filters.http.squash.v3.Squash.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SquashOrBuilder, Cloneable

Enclosing class:

Squash
```
public static final class Squash.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>
implements SquashOrBuilder
```
```
 [#next-free-field: 6]
 
```
Protobuf type envoy.extensions.filters.http.squash.v3.Squash

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Squash.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Squash`	`build()`
`Squash`	`buildPartial()`
`Squash.Builder`	`clear()`
`Squash.Builder`	`clearAttachmentPollPeriod()` Amount of time to poll for the status of the attachment object in the Squash server (to check if has been attached).
`Squash.Builder`	`clearAttachmentTemplate()` When the filter requests the Squash server to create a DebugAttachment, it will use this structure as template for the body of the request.
`Squash.Builder`	`clearAttachmentTimeout()` The total timeout Squash will delay a request and wait for it to be attached.
`Squash.Builder`	`clearCluster()` The name of the cluster that hosts the Squash server.
`Squash.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Squash.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Squash.Builder`	`clearRequestTimeout()` The timeout for individual requests sent to the Squash cluster.
`Squash.Builder`	`clone()`
`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.Duration.Builder`	`getAttachmentPollPeriodBuilder()` 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.Struct.Builder`	`getAttachmentTemplateBuilder()` 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.Duration.Builder`	`getAttachmentTimeoutBuilder()` 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.
`Squash`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`com.google.protobuf.Duration`	`getRequestTimeout()` The timeout for individual requests sent to the Squash cluster.
`com.google.protobuf.Duration.Builder`	`getRequestTimeoutBuilder()` 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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Squash.Builder`	`mergeAttachmentPollPeriod(com.google.protobuf.Duration value)` Amount of time to poll for the status of the attachment object in the Squash server (to check if has been attached).
`Squash.Builder`	`mergeAttachmentTemplate(com.google.protobuf.Struct value)` When the filter requests the Squash server to create a DebugAttachment, it will use this structure as template for the body of the request.
`Squash.Builder`	`mergeAttachmentTimeout(com.google.protobuf.Duration value)` The total timeout Squash will delay a request and wait for it to be attached.
`Squash.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Squash.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Squash.Builder`	`mergeFrom(Squash other)`
`Squash.Builder`	`mergeRequestTimeout(com.google.protobuf.Duration value)` The timeout for individual requests sent to the Squash cluster.
`Squash.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Squash.Builder`	`setAttachmentPollPeriod(com.google.protobuf.Duration.Builder builderForValue)` Amount of time to poll for the status of the attachment object in the Squash server (to check if has been attached).
`Squash.Builder`	`setAttachmentPollPeriod(com.google.protobuf.Duration value)` Amount of time to poll for the status of the attachment object in the Squash server (to check if has been attached).
`Squash.Builder`	`setAttachmentTemplate(com.google.protobuf.Struct.Builder builderForValue)` When the filter requests the Squash server to create a DebugAttachment, it will use this structure as template for the body of the request.
`Squash.Builder`	`setAttachmentTemplate(com.google.protobuf.Struct value)` When the filter requests the Squash server to create a DebugAttachment, it will use this structure as template for the body of the request.
`Squash.Builder`	`setAttachmentTimeout(com.google.protobuf.Duration.Builder builderForValue)` The total timeout Squash will delay a request and wait for it to be attached.
`Squash.Builder`	`setAttachmentTimeout(com.google.protobuf.Duration value)` The total timeout Squash will delay a request and wait for it to be attached.
`Squash.Builder`	`setCluster(String value)` The name of the cluster that hosts the Squash server.
`Squash.Builder`	`setClusterBytes(com.google.protobuf.ByteString value)` The name of the cluster that hosts the Squash server.
`Squash.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Squash.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Squash.Builder`	`setRequestTimeout(com.google.protobuf.Duration.Builder builderForValue)` The timeout for individual requests sent to the Squash cluster.
`Squash.Builder`	`setRequestTimeout(com.google.protobuf.Duration value)` The timeout for individual requests sent to the Squash cluster.
`Squash.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

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.Builder<Squash.Builder>

clear
```
public Squash.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>

getDefaultInstanceForType
```
public Squash getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Squash build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Squash buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public Squash.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>

setField

public Squash.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                               Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>

clearField
```
public Squash.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>

clearOneof
```
public Squash.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>

setRepeatedField

public Squash.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       int index,
                                       Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>

addRepeatedField

public Squash.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>

mergeFrom
```
public Squash.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Squash.Builder>

mergeFrom

public Squash.Builder mergeFrom(Squash other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Squash.Builder>

mergeFrom
```
public Squash.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Squash.Builder>

Throws:

IOException

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

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

setCluster

public Squash.Builder setCluster(String value)

 The name of the cluster that hosts the Squash server.

string cluster = 1 [(.validate.rules) = { ... }

clearCluster

public Squash.Builder clearCluster()

 The name of the cluster that hosts the Squash server.

string cluster = 1 [(.validate.rules) = { ... }

setClusterBytes

public Squash.Builder setClusterBytes(com.google.protobuf.ByteString value)

 The name of the cluster that hosts the Squash server.

string cluster = 1 [(.validate.rules) = { ... }

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

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

setAttachmentTemplate

public Squash.Builder setAttachmentTemplate(com.google.protobuf.Struct value)

 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;

setAttachmentTemplate

public Squash.Builder setAttachmentTemplate(com.google.protobuf.Struct.Builder builderForValue)

 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;

mergeAttachmentTemplate

public Squash.Builder mergeAttachmentTemplate(com.google.protobuf.Struct value)

 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;

clearAttachmentTemplate

public Squash.Builder clearAttachmentTemplate()

 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;

getAttachmentTemplateBuilder

public com.google.protobuf.Struct.Builder getAttachmentTemplateBuilder()

 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;

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

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

setRequestTimeout

public Squash.Builder setRequestTimeout(com.google.protobuf.Duration value)

 The timeout for individual requests sent to the Squash cluster. Defaults to 1 second.

.google.protobuf.Duration request_timeout = 3;

setRequestTimeout

public Squash.Builder setRequestTimeout(com.google.protobuf.Duration.Builder builderForValue)

 The timeout for individual requests sent to the Squash cluster. Defaults to 1 second.

.google.protobuf.Duration request_timeout = 3;

mergeRequestTimeout

public Squash.Builder mergeRequestTimeout(com.google.protobuf.Duration value)

 The timeout for individual requests sent to the Squash cluster. Defaults to 1 second.

.google.protobuf.Duration request_timeout = 3;

clearRequestTimeout

public Squash.Builder clearRequestTimeout()

 The timeout for individual requests sent to the Squash cluster. Defaults to 1 second.

.google.protobuf.Duration request_timeout = 3;

getRequestTimeoutBuilder

public com.google.protobuf.Duration.Builder getRequestTimeoutBuilder()

 The timeout for individual requests sent to the Squash cluster. Defaults to 1 second.

.google.protobuf.Duration request_timeout = 3;

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