Package io.envoyproxy.envoy.api.v2.core

Class GrpcService

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.core.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_api_msg_core.ApiConfigSource>` and filter configurations.
 [#next-free-field: 6]
Protobuf type envoy.api.v2.core.GrpcService
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    GrpcService.Builder
    gRPC service configuration.
    static final class 
    GrpcService.EnvoyGrpc
    Protobuf type envoy.api.v2.core.GrpcService.EnvoyGrpc
    static interface 
    GrpcService.EnvoyGrpcOrBuilder
     
    static final class 
    GrpcService.GoogleGrpc
    [#next-free-field: 7]
    static interface 
    GrpcService.GoogleGrpcOrBuilder
     
    static enum 
    GrpcService.TargetSpecifierCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ENVOY_GRPC_FIELD_NUMBER
     
    static final int
    GOOGLE_GRPC_FIELD_NUMBER
     
    static final int
    INITIAL_METADATA_FIELD_NUMBER
     
    static final int
    TIMEOUT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static GrpcService
    getDefaultInstance()
     
    GrpcService
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    GrpcService.EnvoyGrpc
    getEnvoyGrpc()
    Envoy's in-built gRPC client.
    GrpcService.EnvoyGrpcOrBuilder
    getEnvoyGrpcOrBuilder()
    Envoy's in-built gRPC client.
    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.
    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.
    HeaderValue
    getInitialMetadata(int index)
    Additional metadata to include in streams initiated to the GrpcService.
    int
    getInitialMetadataCount()
    Additional metadata to include in streams initiated to the GrpcService.
    List<HeaderValue>
    getInitialMetadataList()
    Additional metadata to include in streams initiated to the GrpcService.
    HeaderValueOrBuilder
    getInitialMetadataOrBuilder(int index)
    Additional metadata to include in streams initiated to the GrpcService.
    List<? extends HeaderValueOrBuilder>
    getInitialMetadataOrBuilderList()
    Additional metadata to include in streams initiated to the GrpcService.
    com.google.protobuf.Parser<GrpcService>
    getParserForType()
     
    int
    getSerializedSize()
     
    GrpcService.TargetSpecifierCase
    getTargetSpecifierCase()
     
    com.google.protobuf.Duration
    getTimeout()
    The timeout for the gRPC request.
    com.google.protobuf.DurationOrBuilder
    getTimeoutOrBuilder()
    The timeout for the gRPC request.
    boolean
    hasEnvoyGrpc()
    Envoy's in-built gRPC client.
    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.
    int
    hashCode()
     
    boolean
    hasTimeout()
    The timeout for the gRPC request.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static GrpcService.Builder
    newBuilder()
     
    static GrpcService.Builder
    newBuilder(GrpcService prototype)
     
    GrpcService.Builder
    newBuilderForType()
     
    protected GrpcService.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static GrpcService
    parseDelimitedFrom(InputStream input)
     
    static GrpcService
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrpcService
    parseFrom(byte[] data)
     
    static GrpcService
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrpcService
    parseFrom(com.google.protobuf.ByteString data)
     
    static GrpcService
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrpcService
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static GrpcService
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrpcService
    parseFrom(InputStream input)
     
    static GrpcService
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrpcService
    parseFrom(ByteBuffer data)
     
    static GrpcService
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<GrpcService>
    parser()
     
    GrpcService.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • ENVOY_GRPC_FIELD_NUMBER

      public static final int ENVOY_GRPC_FIELD_NUMBER
      See Also:

    • GOOGLE_GRPC_FIELD_NUMBER

      public static final int GOOGLE_GRPC_FIELD_NUMBER
      See Also:

    • TIMEOUT_FIELD_NUMBER

      public static final int TIMEOUT_FIELD_NUMBER
      See Also:

    • INITIAL_METADATA_FIELD_NUMBER

      public static final int INITIAL_METADATA_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getTargetSpecifierCase

      public GrpcService.TargetSpecifierCase getTargetSpecifierCase()
      Specified by:
      getTargetSpecifierCase in interface GrpcServiceOrBuilder

    • 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.api.v2.core.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.api.v2.core.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.api.v2.core.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.api.v2.core.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.api.v2.core.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.api.v2.core.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.
      repeated .envoy.api.v2.core.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.
      repeated .envoy.api.v2.core.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.
      repeated .envoy.api.v2.core.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.
      repeated .envoy.api.v2.core.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.
      repeated .envoy.api.v2.core.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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static GrpcService parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static GrpcService.Builder newBuilder()

    • newBuilder

      public static GrpcService.Builder newBuilder(GrpcService prototype)

    • 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