Interface RouteAction.MaxStreamDurationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RouteAction.MaxStreamDuration, RouteAction.MaxStreamDuration.Builder
Enclosing class:
RouteAction

public static interface RouteAction.MaxStreamDurationOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    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.
    com.google.protobuf.DurationOrBuilder
    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.
    com.google.protobuf.Duration
    If present, Envoy will adjust the timeout provided by the ``grpc-timeout`` header by subtracting the provided duration from the header.
    com.google.protobuf.DurationOrBuilder
    If present, Envoy will adjust the timeout provided by the ``grpc-timeout`` header by subtracting the provided duration from the header.
    com.google.protobuf.Duration
    Specifies the maximum duration allowed for streams on the route.
    com.google.protobuf.DurationOrBuilder
    Specifies the maximum duration allowed for streams on the route.
    boolean
    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.
    boolean
    If present, Envoy will adjust the timeout provided by the ``grpc-timeout`` header by subtracting the provided duration from the header.
    boolean
    Specifies the maximum duration allowed for streams on the route.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • hasMaxStreamDuration

      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;
      Returns:
      Whether the maxStreamDuration field is set.
    • getMaxStreamDuration

      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;
      Returns:
      The maxStreamDuration.
    • getMaxStreamDurationOrBuilder

      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;
    • hasGrpcTimeoutHeaderMax

      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;
      Returns:
      Whether the grpcTimeoutHeaderMax field is set.
    • getGrpcTimeoutHeaderMax

      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;
      Returns:
      The grpcTimeoutHeaderMax.
    • getGrpcTimeoutHeaderMaxOrBuilder

      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;
    • hasGrpcTimeoutHeaderOffset

      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;
      Returns:
      Whether the grpcTimeoutHeaderOffset field is set.
    • getGrpcTimeoutHeaderOffset

      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;
      Returns:
      The grpcTimeoutHeaderOffset.
    • getGrpcTimeoutHeaderOffsetOrBuilder

      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;