Package io.envoyproxy.envoy.api.v2.core
Interface ApiConfigSourceOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ApiConfigSource,ApiConfigSource.Builder
public interface ApiConfigSourceOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ApiConfigSource.ApiTypegetApiType()API type (gRPC, REST, delta gRPC)intgetApiTypeValue()API type (gRPC, REST, delta gRPC)StringgetClusterNames(int index)Cluster names should be used only with REST.com.google.protobuf.ByteStringgetClusterNamesBytes(int index)Cluster names should be used only with REST.intgetClusterNamesCount()Cluster names should be used only with REST.List<String>getClusterNamesList()Cluster names should be used only with REST.GrpcServicegetGrpcServices(int index)Multiple gRPC services be provided for GRPC.intgetGrpcServicesCount()Multiple gRPC services be provided for GRPC.List<GrpcService>getGrpcServicesList()Multiple gRPC services be provided for GRPC.GrpcServiceOrBuildergetGrpcServicesOrBuilder(int index)Multiple gRPC services be provided for GRPC.List<? extends GrpcServiceOrBuilder>getGrpcServicesOrBuilderList()Multiple gRPC services be provided for GRPC.RateLimitSettingsgetRateLimitSettings()For GRPC APIs, the rate limit settings.RateLimitSettingsOrBuildergetRateLimitSettingsOrBuilder()For GRPC APIs, the rate limit settings.com.google.protobuf.DurationgetRefreshDelay()For REST APIs, the delay between successive polls.com.google.protobuf.DurationOrBuildergetRefreshDelayOrBuilder()For REST APIs, the delay between successive polls.com.google.protobuf.DurationgetRequestTimeout()For REST APIs, the request timeout.com.google.protobuf.DurationOrBuildergetRequestTimeoutOrBuilder()For REST APIs, the request timeout.booleangetSetNodeOnFirstMessageOnly()Skip the node identifier in subsequent discovery requests for streaming gRPC config types.ApiVersiongetTransportApiVersion()API version for xDS transport protocol.intgetTransportApiVersionValue()API version for xDS transport protocol.booleanhasRateLimitSettings()For GRPC APIs, the rate limit settings.booleanhasRefreshDelay()For REST APIs, the delay between successive polls.booleanhasRequestTimeout()For REST APIs, the request timeout.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getApiTypeValue
int getApiTypeValue()
API type (gRPC, REST, delta gRPC)
.envoy.api.v2.core.ApiConfigSource.ApiType api_type = 1 [(.validate.rules) = { ... }
-
getApiType
ApiConfigSource.ApiType getApiType()
API type (gRPC, REST, delta gRPC)
.envoy.api.v2.core.ApiConfigSource.ApiType api_type = 1 [(.validate.rules) = { ... }
-
getTransportApiVersionValue
int getTransportApiVersionValue()
API version for xDS transport protocol. This describes the xDS gRPC/REST endpoint and version of [Delta]DiscoveryRequest/Response used on the wire.
.envoy.api.v2.core.ApiVersion transport_api_version = 8 [(.validate.rules) = { ... }
-
getTransportApiVersion
ApiVersion getTransportApiVersion()
API version for xDS transport protocol. This describes the xDS gRPC/REST endpoint and version of [Delta]DiscoveryRequest/Response used on the wire.
.envoy.api.v2.core.ApiVersion transport_api_version = 8 [(.validate.rules) = { ... }
-
getClusterNamesList
List<String> getClusterNamesList()
Cluster names should be used only with REST. If > 1 cluster is defined, clusters will be cycled through if any kind of failure occurs. .. note:: The cluster with name ``cluster_name`` must be statically defined and its type must not be ``EDS``.
repeated string cluster_names = 2;
-
getClusterNamesCount
int getClusterNamesCount()
Cluster names should be used only with REST. If > 1 cluster is defined, clusters will be cycled through if any kind of failure occurs. .. note:: The cluster with name ``cluster_name`` must be statically defined and its type must not be ``EDS``.
repeated string cluster_names = 2;
-
getClusterNames
String getClusterNames(int index)
Cluster names should be used only with REST. If > 1 cluster is defined, clusters will be cycled through if any kind of failure occurs. .. note:: The cluster with name ``cluster_name`` must be statically defined and its type must not be ``EDS``.
repeated string cluster_names = 2;
-
getClusterNamesBytes
com.google.protobuf.ByteString getClusterNamesBytes(int index)
Cluster names should be used only with REST. If > 1 cluster is defined, clusters will be cycled through if any kind of failure occurs. .. note:: The cluster with name ``cluster_name`` must be statically defined and its type must not be ``EDS``.
repeated string cluster_names = 2;
-
getGrpcServicesList
List<GrpcService> getGrpcServicesList()
Multiple gRPC services be provided for GRPC. If > 1 cluster is defined, services will be cycled through if any kind of failure occurs.
repeated .envoy.api.v2.core.GrpcService grpc_services = 4;
-
getGrpcServices
GrpcService getGrpcServices(int index)
Multiple gRPC services be provided for GRPC. If > 1 cluster is defined, services will be cycled through if any kind of failure occurs.
repeated .envoy.api.v2.core.GrpcService grpc_services = 4;
-
getGrpcServicesCount
int getGrpcServicesCount()
Multiple gRPC services be provided for GRPC. If > 1 cluster is defined, services will be cycled through if any kind of failure occurs.
repeated .envoy.api.v2.core.GrpcService grpc_services = 4;
-
getGrpcServicesOrBuilderList
List<? extends GrpcServiceOrBuilder> getGrpcServicesOrBuilderList()
Multiple gRPC services be provided for GRPC. If > 1 cluster is defined, services will be cycled through if any kind of failure occurs.
repeated .envoy.api.v2.core.GrpcService grpc_services = 4;
-
getGrpcServicesOrBuilder
GrpcServiceOrBuilder getGrpcServicesOrBuilder(int index)
Multiple gRPC services be provided for GRPC. If > 1 cluster is defined, services will be cycled through if any kind of failure occurs.
repeated .envoy.api.v2.core.GrpcService grpc_services = 4;
-
hasRefreshDelay
boolean hasRefreshDelay()
For REST APIs, the delay between successive polls.
.google.protobuf.Duration refresh_delay = 3;
-
getRefreshDelay
com.google.protobuf.Duration getRefreshDelay()
For REST APIs, the delay between successive polls.
.google.protobuf.Duration refresh_delay = 3;
-
getRefreshDelayOrBuilder
com.google.protobuf.DurationOrBuilder getRefreshDelayOrBuilder()
For REST APIs, the delay between successive polls.
.google.protobuf.Duration refresh_delay = 3;
-
hasRequestTimeout
boolean hasRequestTimeout()
For REST APIs, the request timeout. If not set, a default value of 1s will be used.
.google.protobuf.Duration request_timeout = 5 [(.validate.rules) = { ... }
-
getRequestTimeout
com.google.protobuf.Duration getRequestTimeout()
For REST APIs, the request timeout. If not set, a default value of 1s will be used.
.google.protobuf.Duration request_timeout = 5 [(.validate.rules) = { ... }
-
getRequestTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getRequestTimeoutOrBuilder()
For REST APIs, the request timeout. If not set, a default value of 1s will be used.
.google.protobuf.Duration request_timeout = 5 [(.validate.rules) = { ... }
-
hasRateLimitSettings
boolean hasRateLimitSettings()
For GRPC APIs, the rate limit settings. If present, discovery requests made by Envoy will be rate limited.
.envoy.api.v2.core.RateLimitSettings rate_limit_settings = 6;
-
getRateLimitSettings
RateLimitSettings getRateLimitSettings()
For GRPC APIs, the rate limit settings. If present, discovery requests made by Envoy will be rate limited.
.envoy.api.v2.core.RateLimitSettings rate_limit_settings = 6;
-
getRateLimitSettingsOrBuilder
RateLimitSettingsOrBuilder getRateLimitSettingsOrBuilder()
For GRPC APIs, the rate limit settings. If present, discovery requests made by Envoy will be rate limited.
.envoy.api.v2.core.RateLimitSettings rate_limit_settings = 6;
-
getSetNodeOnFirstMessageOnly
boolean getSetNodeOnFirstMessageOnly()
Skip the node identifier in subsequent discovery requests for streaming gRPC config types.
bool set_node_on_first_message_only = 7;
-
-