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, 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 Detail

      • newInstance

        protected 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 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 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 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 ImmediateResponse parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImmediateResponse parseFrom​(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​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        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