Package io.envoyproxy.envoy.config.core.v3

Class GrpcService

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GrpcServiceOrBuilder, java.io.Serializable
    public final class GrpcService
extends com.google.protobuf.GeneratedMessage
implements GrpcServiceOrBuilder
     gRPC service configuration. This is used by :ref:`ApiConfigSource
 <envoy_v3_api_msg_config.core.v3.ApiConfigSource>` and filter configurations.
 [#next-free-field: 7]
    Protobuf type envoy.config.core.v3.GrpcService
    See Also:
    Serialized Form

    • Field Detail

      • bitField0_

        private int bitField0_

      • targetSpecifierCase_

        private int targetSpecifierCase_

      • targetSpecifier_

        private java.lang.Object targetSpecifier_

      • ENVOY_GRPC_FIELD_NUMBER

        public static final int ENVOY_GRPC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GOOGLE_GRPC_FIELD_NUMBER

        public static final int GOOGLE_GRPC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • timeout_

        private com.google.protobuf.Duration timeout_

      • INITIAL_METADATA_FIELD_NUMBER

        public static final int INITIAL_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • initialMetadata_

        private java.util.List<HeaderValue> initialMetadata_

      • RETRY_POLICY_FIELD_NUMBER

        public static final int RETRY_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • memoizedIsInitialized

        private byte memoizedIsInitialized

      • DEFAULT_INSTANCE

        private static final GrpcService DEFAULT_INSTANCE

      • PARSER

        private static final com.google.protobuf.Parser<GrpcService> PARSER

    • Constructor Detail

      • GrpcService

        private GrpcService​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • GrpcService

        private GrpcService()

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • hasEnvoyGrpc

        public boolean hasEnvoyGrpc()
         Envoy's in-built gRPC client.
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
        .envoy.config.core.v3.GrpcService.EnvoyGrpc envoy_grpc = 1;
        Specified by:
        hasEnvoyGrpc in interface GrpcServiceOrBuilder
        Returns:
        Whether the envoyGrpc field is set.

      • getEnvoyGrpc

        public GrpcService.EnvoyGrpc getEnvoyGrpc()
         Envoy's in-built gRPC client.
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
        .envoy.config.core.v3.GrpcService.EnvoyGrpc envoy_grpc = 1;
        Specified by:
        getEnvoyGrpc in interface GrpcServiceOrBuilder
        Returns:
        The envoyGrpc.

      • getEnvoyGrpcOrBuilder

        public GrpcService.EnvoyGrpcOrBuilder getEnvoyGrpcOrBuilder()
         Envoy's in-built gRPC client.
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
        .envoy.config.core.v3.GrpcService.EnvoyGrpc envoy_grpc = 1;
        Specified by:
        getEnvoyGrpcOrBuilder in interface GrpcServiceOrBuilder

      • hasGoogleGrpc

        public boolean hasGoogleGrpc()
         `Google C++ gRPC client <https://github.com/grpc/grpc>`_
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
        .envoy.config.core.v3.GrpcService.GoogleGrpc google_grpc = 2;
        Specified by:
        hasGoogleGrpc in interface GrpcServiceOrBuilder
        Returns:
        Whether the googleGrpc field is set.

      • getGoogleGrpc

        public GrpcService.GoogleGrpc getGoogleGrpc()
         `Google C++ gRPC client <https://github.com/grpc/grpc>`_
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
        .envoy.config.core.v3.GrpcService.GoogleGrpc google_grpc = 2;
        Specified by:
        getGoogleGrpc in interface GrpcServiceOrBuilder
        Returns:
        The googleGrpc.

      • getGoogleGrpcOrBuilder

        public GrpcService.GoogleGrpcOrBuilder getGoogleGrpcOrBuilder()
         `Google C++ gRPC client <https://github.com/grpc/grpc>`_
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
        .envoy.config.core.v3.GrpcService.GoogleGrpc google_grpc = 2;
        Specified by:
        getGoogleGrpcOrBuilder in interface GrpcServiceOrBuilder

      • hasTimeout

        public boolean hasTimeout()
         The timeout for the gRPC request. This is the timeout for a specific
 request.
        .google.protobuf.Duration timeout = 3;
        Specified by:
        hasTimeout in interface GrpcServiceOrBuilder
        Returns:
        Whether the timeout field is set.

      • getTimeout

        public com.google.protobuf.Duration getTimeout()
         The timeout for the gRPC request. This is the timeout for a specific
 request.
        .google.protobuf.Duration timeout = 3;
        Specified by:
        getTimeout in interface GrpcServiceOrBuilder
        Returns:
        The timeout.

      • getTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
         The timeout for the gRPC request. This is the timeout for a specific
 request.
        .google.protobuf.Duration timeout = 3;
        Specified by:
        getTimeoutOrBuilder in interface GrpcServiceOrBuilder

      • getInitialMetadataList

        public java.util.List<HeaderValue> getInitialMetadataList()
         Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;
        Specified by:
        getInitialMetadataList in interface GrpcServiceOrBuilder

      • getInitialMetadataOrBuilderList

        public java.util.List<? extends HeaderValueOrBuilder> getInitialMetadataOrBuilderList()
         Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;
        Specified by:
        getInitialMetadataOrBuilderList in interface GrpcServiceOrBuilder

      • getInitialMetadataCount

        public int getInitialMetadataCount()
         Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;
        Specified by:
        getInitialMetadataCount in interface GrpcServiceOrBuilder

      • getInitialMetadata

        public HeaderValue getInitialMetadata​(int index)
         Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;
        Specified by:
        getInitialMetadata in interface GrpcServiceOrBuilder

      • getInitialMetadataOrBuilder

        public HeaderValueOrBuilder getInitialMetadataOrBuilder​(int index)
         Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;
        Specified by:
        getInitialMetadataOrBuilder in interface GrpcServiceOrBuilder

      • hasRetryPolicy

        public boolean hasRetryPolicy()
         Optional default retry policy for streams toward the service.
 If an async stream doesn't have retry policy configured in its stream options, this retry policy is used.
        .envoy.config.core.v3.RetryPolicy retry_policy = 6;
        Specified by:
        hasRetryPolicy in interface GrpcServiceOrBuilder
        Returns:
        Whether the retryPolicy field is set.

      • getRetryPolicy

        public RetryPolicy getRetryPolicy()
         Optional default retry policy for streams toward the service.
 If an async stream doesn't have retry policy configured in its stream options, this retry policy is used.
        .envoy.config.core.v3.RetryPolicy retry_policy = 6;
        Specified by:
        getRetryPolicy in interface GrpcServiceOrBuilder
        Returns:
        The retryPolicy.

      • getRetryPolicyOrBuilder

        public RetryPolicyOrBuilder getRetryPolicyOrBuilder()
         Optional default retry policy for streams toward the service.
 If an async stream doesn't have retry policy configured in its stream options, this retry policy is used.
        .envoy.config.core.v3.RetryPolicy retry_policy = 6;
        Specified by:
        getRetryPolicyOrBuilder in interface GrpcServiceOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • 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.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected GrpcService.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getDefaultInstance

        public static GrpcService getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<GrpcService> parser()

      • getParserForType

        public com.google.protobuf.Parser<GrpcService> 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.GeneratedMessage

      • getDefaultInstanceForType

        public GrpcService getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder