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, Serializable
    public final class GrpcService
extends com.google.protobuf.GeneratedMessageV3
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: 6]
    Protobuf type envoy.config.core.v3.GrpcService
    See Also:
    Serialized Form

    • 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

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

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

      • parseFrom

        public static GrpcService parseFrom​(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​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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