io.envoyproxy.envoy.config.core.v3

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

Modifier and Type	Method and Description
ApiConfigSource.ApiType	getApiType() API type (gRPC, REST, delta gRPC) .envoy.config.core.v3.ApiConfigSource.ApiType api_type = 1 [(.validate.rules) = { ... }
int	getApiTypeValue() API type (gRPC, REST, delta gRPC) .envoy.config.core.v3.ApiConfigSource.ApiType api_type = 1 [(.validate.rules) = { ... }
String	getClusterNames(int index) Cluster names should be used only with REST.
com.google.protobuf.ByteString	getClusterNamesBytes(int index) Cluster names should be used only with REST.
int	getClusterNamesCount() Cluster names should be used only with REST.
List<String>	getClusterNamesList() Cluster names should be used only with REST.
GrpcService	getGrpcServices(int index) Multiple gRPC services be provided for GRPC.
int	getGrpcServicesCount() Multiple gRPC services be provided for GRPC.
List<GrpcService>	getGrpcServicesList() Multiple gRPC services be provided for GRPC.
GrpcServiceOrBuilder	getGrpcServicesOrBuilder(int index) Multiple gRPC services be provided for GRPC.
List<? extends GrpcServiceOrBuilder>	getGrpcServicesOrBuilderList() Multiple gRPC services be provided for GRPC.
RateLimitSettings	getRateLimitSettings() For GRPC APIs, the rate limit settings.
RateLimitSettingsOrBuilder	getRateLimitSettingsOrBuilder() For GRPC APIs, the rate limit settings.
com.google.protobuf.Duration	getRefreshDelay() For REST APIs, the delay between successive polls.
com.google.protobuf.DurationOrBuilder	getRefreshDelayOrBuilder() For REST APIs, the delay between successive polls.
com.google.protobuf.Duration	getRequestTimeout() For REST APIs, the request timeout.
com.google.protobuf.DurationOrBuilder	getRequestTimeoutOrBuilder() For REST APIs, the request timeout.
boolean	getSetNodeOnFirstMessageOnly() Skip the node identifier in subsequent discovery requests for streaming gRPC config types.
ApiVersion	getTransportApiVersion() API version for xDS transport protocol.
int	getTransportApiVersionValue() API version for xDS transport protocol.
boolean	hasRateLimitSettings() For GRPC APIs, the rate limit settings.
boolean	hasRefreshDelay() For REST APIs, the delay between successive polls.
boolean	hasRequestTimeout() 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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getApiTypeValue

int getApiTypeValue()

 API type (gRPC, REST, delta gRPC)
 

.envoy.config.core.v3.ApiConfigSource.ApiType api_type = 1 [(.validate.rules) = { ... }

getApiType

ApiConfigSource.ApiType getApiType()

 API type (gRPC, REST, delta gRPC)
 

.envoy.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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;