Class GrpcService
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.core.v3.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.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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
gRPC service configuration.static final class
[#next-free-field: 6]static interface
static final class
[#next-free-field: 9]static interface
static enum
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final GrpcService
static final int
static final int
static final int
private List
<HeaderValue> private byte
private static final com.google.protobuf.Parser
<GrpcService> static final int
private RetryPolicy
private static final long
private Object
private int
private com.google.protobuf.Duration
static final int
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
GrpcService
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static GrpcService
static final com.google.protobuf.Descriptors.Descriptor
Envoy's in-built gRPC client.Envoy's in-built gRPC client.`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.`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.getInitialMetadata
(int index) Additional metadata to include in streams initiated to the GrpcService.int
Additional metadata to include in streams initiated to the GrpcService.Additional metadata to include in streams initiated to the GrpcService.getInitialMetadataOrBuilder
(int index) Additional metadata to include in streams initiated to the GrpcService.List
<? extends HeaderValueOrBuilder> Additional metadata to include in streams initiated to the GrpcService.com.google.protobuf.Parser
<GrpcService> Optional default retry policy for streams toward the service.Optional default retry policy for streams toward the service.int
com.google.protobuf.Duration
The timeout for the gRPC request.com.google.protobuf.DurationOrBuilder
The timeout for the gRPC request.boolean
Envoy's in-built gRPC client.boolean
`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
Optional default retry policy for streams toward the service.boolean
The timeout for the gRPC request.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static GrpcService.Builder
static GrpcService.Builder
newBuilder
(GrpcService prototype) protected GrpcService.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) 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()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
targetSpecifierCase_
private int targetSpecifierCase_ -
targetSpecifier_
-
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:
-
timeout_
private com.google.protobuf.Duration timeout_ -
INITIAL_METADATA_FIELD_NUMBER
public static final int INITIAL_METADATA_FIELD_NUMBER- See Also:
-
initialMetadata_
-
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER- See Also:
-
retryPolicy_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
GrpcService
private GrpcService(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
GrpcService
private GrpcService()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getTargetSpecifierCase
- Specified by:
getTargetSpecifierCase
in interfaceGrpcServiceOrBuilder
-
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 interfaceGrpcServiceOrBuilder
- Returns:
- Whether the envoyGrpc field is set.
-
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 interfaceGrpcServiceOrBuilder
- Returns:
- The envoyGrpc.
-
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 interfaceGrpcServiceOrBuilder
-
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 interfaceGrpcServiceOrBuilder
- Returns:
- Whether the googleGrpc field is set.
-
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 interfaceGrpcServiceOrBuilder
- Returns:
- The googleGrpc.
-
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 interfaceGrpcServiceOrBuilder
-
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 interfaceGrpcServiceOrBuilder
- 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 interfaceGrpcServiceOrBuilder
- 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 interfaceGrpcServiceOrBuilder
-
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 interfaceGrpcServiceOrBuilder
-
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 interfaceGrpcServiceOrBuilder
-
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 interfaceGrpcServiceOrBuilder
-
getInitialMetadata
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 interfaceGrpcServiceOrBuilder
-
getInitialMetadataOrBuilder
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 interfaceGrpcServiceOrBuilder
-
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 interfaceGrpcServiceOrBuilder
- Returns:
- Whether the retryPolicy field is set.
-
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 interfaceGrpcServiceOrBuilder
- Returns:
- The retryPolicy.
-
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 interfaceGrpcServiceOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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
- Throws:
IOException
-
parseFrom
public static GrpcService parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static GrpcService parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static GrpcService parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected GrpcService.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-