Package 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 Detail

      • getApiTypeValue

        int getApiTypeValue()
         API type (gRPC, REST, delta gRPC)
        .envoy.config.core.v3.ApiConfigSource.ApiType api_type = 1 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for apiType.

      • getApiType

        ApiConfigSource.ApiType getApiType()
         API type (gRPC, REST, delta gRPC)
        .envoy.config.core.v3.ApiConfigSource.ApiType api_type = 1 [(.validate.rules) = { ... }
        Returns:
        The apiType.

      • 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) = { ... }
        Returns:
        The enum numeric value on the wire for transportApiVersion.

      • 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) = { ... }
        Returns:
        The transportApiVersion.

      • 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;
        Returns:
        A list containing the clusterNames.

      • 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;
        Returns:
        The count of clusterNames.

      • 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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The clusterNames at the given index.

      • 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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the clusterNames at the given index.

      • 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;
        Returns:
        Whether the refreshDelay field is set.

      • getRefreshDelay

        com.google.protobuf.Duration getRefreshDelay()
         For REST APIs, the delay between successive polls.
        .google.protobuf.Duration refresh_delay = 3;
        Returns:
        The refreshDelay.

      • 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) = { ... }
        Returns:
        Whether the requestTimeout field is set.

      • 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) = { ... }
        Returns:
        The requestTimeout.

      • 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;
        Returns:
        Whether the rateLimitSettings field is set.

      • 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;
        Returns:
        The rateLimitSettings.

      • 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;
        Returns:
        The setNodeOnFirstMessageOnly.

      • getConfigValidatorsList

        List<TypedExtensionConfig> getConfigValidatorsList()
         A list of config validators that will be executed when a new update is
 received from the ApiConfigSource. Note that each validator handles a
 specific xDS service type, and only the validators corresponding to the
 type url (in ``:ref: DiscoveryResponse`` or ``:ref: DeltaDiscoveryResponse``)
 will be invoked.
 If the validator returns false or throws an exception, the config will be rejected by
 the client, and a NACK will be sent.
 [#extension-category: envoy.config.validators]
        repeated .envoy.config.core.v3.TypedExtensionConfig config_validators = 9;

      • getConfigValidators

        TypedExtensionConfig getConfigValidators​(int index)
         A list of config validators that will be executed when a new update is
 received from the ApiConfigSource. Note that each validator handles a
 specific xDS service type, and only the validators corresponding to the
 type url (in ``:ref: DiscoveryResponse`` or ``:ref: DeltaDiscoveryResponse``)
 will be invoked.
 If the validator returns false or throws an exception, the config will be rejected by
 the client, and a NACK will be sent.
 [#extension-category: envoy.config.validators]
        repeated .envoy.config.core.v3.TypedExtensionConfig config_validators = 9;

      • getConfigValidatorsCount

        int getConfigValidatorsCount()
         A list of config validators that will be executed when a new update is
 received from the ApiConfigSource. Note that each validator handles a
 specific xDS service type, and only the validators corresponding to the
 type url (in ``:ref: DiscoveryResponse`` or ``:ref: DeltaDiscoveryResponse``)
 will be invoked.
 If the validator returns false or throws an exception, the config will be rejected by
 the client, and a NACK will be sent.
 [#extension-category: envoy.config.validators]
        repeated .envoy.config.core.v3.TypedExtensionConfig config_validators = 9;

      • getConfigValidatorsOrBuilderList

        List<? extends TypedExtensionConfigOrBuilder> getConfigValidatorsOrBuilderList()
         A list of config validators that will be executed when a new update is
 received from the ApiConfigSource. Note that each validator handles a
 specific xDS service type, and only the validators corresponding to the
 type url (in ``:ref: DiscoveryResponse`` or ``:ref: DeltaDiscoveryResponse``)
 will be invoked.
 If the validator returns false or throws an exception, the config will be rejected by
 the client, and a NACK will be sent.
 [#extension-category: envoy.config.validators]
        repeated .envoy.config.core.v3.TypedExtensionConfig config_validators = 9;

      • getConfigValidatorsOrBuilder

        TypedExtensionConfigOrBuilder getConfigValidatorsOrBuilder​(int index)
         A list of config validators that will be executed when a new update is
 received from the ApiConfigSource. Note that each validator handles a
 specific xDS service type, and only the validators corresponding to the
 type url (in ``:ref: DiscoveryResponse`` or ``:ref: DeltaDiscoveryResponse``)
 will be invoked.
 If the validator returns false or throws an exception, the config will be rejected by
 the client, and a NACK will be sent.
 [#extension-category: envoy.config.validators]
        repeated .envoy.config.core.v3.TypedExtensionConfig config_validators = 9;