Package io.envoyproxy.envoy.service.ext_proc.v3

Class ImmediateResponse

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ImmediateResponseOrBuilder, java.io.Serializable
    public final class ImmediateResponse
extends com.google.protobuf.GeneratedMessageV3
implements ImmediateResponseOrBuilder
     This message causes the filter to attempt to create a locally
 generated response, send it  downstream, stop processing
 additional filters, and ignore any additional messages received
 from the remote server for this request or response. If a response
 has already started, then  this will either ship the reply directly
 to the downstream codec, or reset the stream.
 [#next-free-field: 6]
    Protobuf type envoy.service.ext_proc.v3.ImmediateResponse
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ImmediateResponse.Builder
      This message causes the filter to attempt to create a locally generated response, send it downstream, stop processing additional filters, and ignore any additional messages received from the remote server for this request or response.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getBody()
      The message body to return with the response which is sent using the text/plain content type, or encoded in the grpc-message header.
      com.google.protobuf.ByteString getBodyBytes()
      The message body to return with the response which is sent using the text/plain content type, or encoded in the grpc-message header.
      static ImmediateResponse getDefaultInstance()  
      ImmediateResponse getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getDetails()
      A string detailing why this local reply was sent, which may be included in log and debug output (e.g.
      com.google.protobuf.ByteString getDetailsBytes()
      A string detailing why this local reply was sent, which may be included in log and debug output (e.g.
      GrpcStatus getGrpcStatus()
      If set, then include a gRPC status trailer.
      GrpcStatusOrBuilder getGrpcStatusOrBuilder()
      If set, then include a gRPC status trailer.
      HeaderMutation getHeaders()
      Apply changes to the default headers, which will include content-type.
      HeaderMutationOrBuilder getHeadersOrBuilder()
      Apply changes to the default headers, which will include content-type.
      com.google.protobuf.Parser<ImmediateResponse> getParserForType()  
      int getSerializedSize()  
      HttpStatus getStatus()
      The response code to return
      HttpStatusOrBuilder getStatusOrBuilder()
      The response code to return
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasGrpcStatus()
      If set, then include a gRPC status trailer.
      int hashCode()  
      boolean hasHeaders()
      Apply changes to the default headers, which will include content-type.
      boolean hasStatus()
      The response code to return
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ImmediateResponse.Builder newBuilder()  
      static ImmediateResponse.Builder newBuilder​(ImmediateResponse prototype)  
      ImmediateResponse.Builder newBuilderForType()  
      protected ImmediateResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static ImmediateResponse parseDelimitedFrom​(java.io.InputStream input)  
      static ImmediateResponse parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ImmediateResponse parseFrom​(byte[] data)  
      static ImmediateResponse parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ImmediateResponse parseFrom​(com.google.protobuf.ByteString data)  
      static ImmediateResponse parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ImmediateResponse parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ImmediateResponse parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ImmediateResponse parseFrom​(java.io.InputStream input)  
      static ImmediateResponse parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ImmediateResponse parseFrom​(java.nio.ByteBuffer data)  
      static ImmediateResponse parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ImmediateResponse> parser()  
      ImmediateResponse.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasStatus

        public boolean hasStatus()
         The response code to return
        .envoy.type.v3.HttpStatus status = 1 [(.validate.rules) = { ... }
        Specified by:
        hasStatus in interface ImmediateResponseOrBuilder
        Returns:
        Whether the status field is set.

      • hasHeaders

        public boolean hasHeaders()
         Apply changes to the default headers, which will include content-type.
        .envoy.service.ext_proc.v3.HeaderMutation headers = 2;
        Specified by:
        hasHeaders in interface ImmediateResponseOrBuilder
        Returns:
        Whether the headers field is set.

      • getHeaders

        public HeaderMutation getHeaders()
         Apply changes to the default headers, which will include content-type.
        .envoy.service.ext_proc.v3.HeaderMutation headers = 2;
        Specified by:
        getHeaders in interface ImmediateResponseOrBuilder
        Returns:
        The headers.

      • getBody

        public java.lang.String getBody()
         The message body to return with the response which is sent using the
 text/plain content type, or encoded in the grpc-message header.
        string body = 3;
        Specified by:
        getBody in interface ImmediateResponseOrBuilder
        Returns:
        The body.

      • getBodyBytes

        public com.google.protobuf.ByteString getBodyBytes()
         The message body to return with the response which is sent using the
 text/plain content type, or encoded in the grpc-message header.
        string body = 3;
        Specified by:
        getBodyBytes in interface ImmediateResponseOrBuilder
        Returns:
        The bytes for body.

      • hasGrpcStatus

        public boolean hasGrpcStatus()
         If set, then include a gRPC status trailer.
        .envoy.service.ext_proc.v3.GrpcStatus grpc_status = 4;
        Specified by:
        hasGrpcStatus in interface ImmediateResponseOrBuilder
        Returns:
        Whether the grpcStatus field is set.

      • getGrpcStatus

        public GrpcStatus getGrpcStatus()
         If set, then include a gRPC status trailer.
        .envoy.service.ext_proc.v3.GrpcStatus grpc_status = 4;
        Specified by:
        getGrpcStatus in interface ImmediateResponseOrBuilder
        Returns:
        The grpcStatus.

      • getDetails

        public java.lang.String getDetails()
         A string detailing why this local reply was sent, which may be included
 in log and debug output (e.g. this populates the %RESPONSE_CODE_DETAILS%
 command operator field for use in access logging).
        string details = 5;
        Specified by:
        getDetails in interface ImmediateResponseOrBuilder
        Returns:
        The details.

      • getDetailsBytes

        public com.google.protobuf.ByteString getDetailsBytes()
         A string detailing why this local reply was sent, which may be included
 in log and debug output (e.g. this populates the %RESPONSE_CODE_DETAILS%
 command operator field for use in access logging).
        string details = 5;
        Specified by:
        getDetailsBytes in interface ImmediateResponseOrBuilder
        Returns:
        The bytes for details.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 ImmediateResponse parseFrom​(java.nio.ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImmediateResponse parseFrom​(java.nio.ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static ImmediateResponse parseFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ImmediateResponse parseFrom​(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ImmediateResponse parseDelimitedFrom​(java.io.InputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ImmediateResponse parseDelimitedFrom​(java.io.InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ImmediateResponse parseFrom​(com.google.protobuf.CodedInputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ImmediateResponse parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ImmediateResponse> 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 ImmediateResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder