Package io.envoyproxy.envoy.config.route.v3

Class RouteAction.MaxStreamDuration

    • Field Detail

      • MAX_STREAM_DURATION_FIELD_NUMBER

        public static final int MAX_STREAM_DURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GRPC_TIMEOUT_HEADER_MAX_FIELD_NUMBER

        public static final int GRPC_TIMEOUT_HEADER_MAX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GRPC_TIMEOUT_HEADER_OFFSET_FIELD_NUMBER

        public static final int GRPC_TIMEOUT_HEADER_OFFSET_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • hasMaxStreamDuration

        public boolean hasMaxStreamDuration()
         Specifies the maximum duration allowed for streams on the route. If not specified, the value
 from the :ref:`max_stream_duration
 <envoy_v3_api_field_config.core.v3.HttpProtocolOptions.max_stream_duration>` field in
 :ref:`HttpConnectionManager.common_http_protocol_options
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.common_http_protocol_options>`
 is used. If this field is set explicitly to zero, any
 HttpConnectionManager max_stream_duration timeout will be disabled for
 this route.
        .google.protobuf.Duration max_stream_duration = 1;
        Specified by:
        hasMaxStreamDuration in interface RouteAction.MaxStreamDurationOrBuilder
        Returns:
        Whether the maxStreamDuration field is set.

      • getMaxStreamDuration

        public com.google.protobuf.Duration getMaxStreamDuration()
         Specifies the maximum duration allowed for streams on the route. If not specified, the value
 from the :ref:`max_stream_duration
 <envoy_v3_api_field_config.core.v3.HttpProtocolOptions.max_stream_duration>` field in
 :ref:`HttpConnectionManager.common_http_protocol_options
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.common_http_protocol_options>`
 is used. If this field is set explicitly to zero, any
 HttpConnectionManager max_stream_duration timeout will be disabled for
 this route.
        .google.protobuf.Duration max_stream_duration = 1;
        Specified by:
        getMaxStreamDuration in interface RouteAction.MaxStreamDurationOrBuilder
        Returns:
        The maxStreamDuration.

      • getMaxStreamDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getMaxStreamDurationOrBuilder()
         Specifies the maximum duration allowed for streams on the route. If not specified, the value
 from the :ref:`max_stream_duration
 <envoy_v3_api_field_config.core.v3.HttpProtocolOptions.max_stream_duration>` field in
 :ref:`HttpConnectionManager.common_http_protocol_options
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.common_http_protocol_options>`
 is used. If this field is set explicitly to zero, any
 HttpConnectionManager max_stream_duration timeout will be disabled for
 this route.
        .google.protobuf.Duration max_stream_duration = 1;
        Specified by:
        getMaxStreamDurationOrBuilder in interface RouteAction.MaxStreamDurationOrBuilder

      • hasGrpcTimeoutHeaderMax

        public boolean hasGrpcTimeoutHeaderMax()
         If present, and the request contains a `grpc-timeout header
 <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_, use that value as the
 ``max_stream_duration``, but limit the applied timeout to the maximum value specified here.
 If set to 0, the ``grpc-timeout`` header is used without modification.
        .google.protobuf.Duration grpc_timeout_header_max = 2;
        Specified by:
        hasGrpcTimeoutHeaderMax in interface RouteAction.MaxStreamDurationOrBuilder
        Returns:
        Whether the grpcTimeoutHeaderMax field is set.

      • getGrpcTimeoutHeaderMax

        public com.google.protobuf.Duration getGrpcTimeoutHeaderMax()
         If present, and the request contains a `grpc-timeout header
 <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_, use that value as the
 ``max_stream_duration``, but limit the applied timeout to the maximum value specified here.
 If set to 0, the ``grpc-timeout`` header is used without modification.
        .google.protobuf.Duration grpc_timeout_header_max = 2;
        Specified by:
        getGrpcTimeoutHeaderMax in interface RouteAction.MaxStreamDurationOrBuilder
        Returns:
        The grpcTimeoutHeaderMax.

      • getGrpcTimeoutHeaderMaxOrBuilder

        public com.google.protobuf.DurationOrBuilder getGrpcTimeoutHeaderMaxOrBuilder()
         If present, and the request contains a `grpc-timeout header
 <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_, use that value as the
 ``max_stream_duration``, but limit the applied timeout to the maximum value specified here.
 If set to 0, the ``grpc-timeout`` header is used without modification.
        .google.protobuf.Duration grpc_timeout_header_max = 2;
        Specified by:
        getGrpcTimeoutHeaderMaxOrBuilder in interface RouteAction.MaxStreamDurationOrBuilder

      • hasGrpcTimeoutHeaderOffset

        public boolean hasGrpcTimeoutHeaderOffset()
         If present, Envoy will adjust the timeout provided by the ``grpc-timeout`` header by
 subtracting the provided duration from the header. This is useful for allowing Envoy to set
 its global timeout to be less than that of the deadline imposed by the calling client, which
 makes it more likely that Envoy will handle the timeout instead of having the call canceled
 by the client. If, after applying the offset, the resulting timeout is zero or negative,
 the stream will timeout immediately.
        .google.protobuf.Duration grpc_timeout_header_offset = 3;
        Specified by:
        hasGrpcTimeoutHeaderOffset in interface RouteAction.MaxStreamDurationOrBuilder
        Returns:
        Whether the grpcTimeoutHeaderOffset field is set.

      • getGrpcTimeoutHeaderOffset

        public com.google.protobuf.Duration getGrpcTimeoutHeaderOffset()
         If present, Envoy will adjust the timeout provided by the ``grpc-timeout`` header by
 subtracting the provided duration from the header. This is useful for allowing Envoy to set
 its global timeout to be less than that of the deadline imposed by the calling client, which
 makes it more likely that Envoy will handle the timeout instead of having the call canceled
 by the client. If, after applying the offset, the resulting timeout is zero or negative,
 the stream will timeout immediately.
        .google.protobuf.Duration grpc_timeout_header_offset = 3;
        Specified by:
        getGrpcTimeoutHeaderOffset in interface RouteAction.MaxStreamDurationOrBuilder
        Returns:
        The grpcTimeoutHeaderOffset.

      • getGrpcTimeoutHeaderOffsetOrBuilder

        public com.google.protobuf.DurationOrBuilder getGrpcTimeoutHeaderOffsetOrBuilder()
         If present, Envoy will adjust the timeout provided by the ``grpc-timeout`` header by
 subtracting the provided duration from the header. This is useful for allowing Envoy to set
 its global timeout to be less than that of the deadline imposed by the calling client, which
 makes it more likely that Envoy will handle the timeout instead of having the call canceled
 by the client. If, after applying the offset, the resulting timeout is zero or negative,
 the stream will timeout immediately.
        .google.protobuf.Duration grpc_timeout_header_offset = 3;
        Specified by:
        getGrpcTimeoutHeaderOffsetOrBuilder in interface RouteAction.MaxStreamDurationOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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