Package io.envoyproxy.envoy.service.discovery.v3

Interface ResourceOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Resource, Resource.Builder
    public interface ResourceOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAliases​(int index)
      The aliases are a list of other names that this resource can go by.
      com.google.protobuf.ByteString getAliasesBytes​(int index)
      The aliases are a list of other names that this resource can go by.
      int getAliasesCount()
      The aliases are a list of other names that this resource can go by.
      List<String> getAliasesList()
      The aliases are a list of other names that this resource can go by.
      Resource.CacheControl getCacheControl()
      Cache control properties for the resource.
      Resource.CacheControlOrBuilder getCacheControlOrBuilder()
      Cache control properties for the resource.
      String getName()
      The resource's name, to distinguish it from others of the same type of resource.
      com.google.protobuf.ByteString getNameBytes()
      The resource's name, to distinguish it from others of the same type of resource.
      com.google.protobuf.Any getResource()
      The resource being tracked.
      com.google.protobuf.AnyOrBuilder getResourceOrBuilder()
      The resource being tracked.
      com.google.protobuf.Duration getTtl()
      Time-to-live value for the resource.
      com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
      Time-to-live value for the resource.
      String getVersion()
      The resource level version.
      com.google.protobuf.ByteString getVersionBytes()
      The resource level version.
      boolean hasCacheControl()
      Cache control properties for the resource.
      boolean hasResource()
      The resource being tracked.
      boolean hasTtl()
      Time-to-live value for the resource.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getName

        String getName()
         The resource's name, to distinguish it from others of the same type of resource.
        string name = 3;

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The resource's name, to distinguish it from others of the same type of resource.
        string name = 3;

      • getAliasesList

        List<String> getAliasesList()
         The aliases are a list of other names that this resource can go by.
        repeated string aliases = 4;

      • getAliasesCount

        int getAliasesCount()
         The aliases are a list of other names that this resource can go by.
        repeated string aliases = 4;

      • getAliases

        String getAliases​(int index)
         The aliases are a list of other names that this resource can go by.
        repeated string aliases = 4;

      • getAliasesBytes

        com.google.protobuf.ByteString getAliasesBytes​(int index)
         The aliases are a list of other names that this resource can go by.
        repeated string aliases = 4;

      • getVersion

        String getVersion()
         The resource level version. It allows xDS to track the state of individual
 resources.
        string version = 1;

      • getVersionBytes

        com.google.protobuf.ByteString getVersionBytes()
         The resource level version. It allows xDS to track the state of individual
 resources.
        string version = 1;

      • hasResource

        boolean hasResource()
         The resource being tracked.
        .google.protobuf.Any resource = 2;

      • getResource

        com.google.protobuf.Any getResource()
         The resource being tracked.
        .google.protobuf.Any resource = 2;

      • getResourceOrBuilder

        com.google.protobuf.AnyOrBuilder getResourceOrBuilder()
         The resource being tracked.
        .google.protobuf.Any resource = 2;

      • hasTtl

        boolean hasTtl()
         Time-to-live value for the resource. For each resource, a timer is started. The timer is
 reset each time the resource is received with a new TTL. If the resource is received with
 no TTL set, the timer is removed for the resource. Upon expiration of the timer, the
 configuration for the resource will be removed.
 The TTL can be refreshed or changed by sending a response that doesn't change the resource
 version. In this case the resource field does not need to be populated, which allows for
 light-weight "heartbeat" updates to keep a resource with a TTL alive.
 The TTL feature is meant to support configurations that should be removed in the event of
 a management server failure. For example, the feature may be used for fault injection
 testing where the fault injection should be terminated in the event that Envoy loses contact
 with the management server.
        .google.protobuf.Duration ttl = 6;

      • getTtl

        com.google.protobuf.Duration getTtl()
         Time-to-live value for the resource. For each resource, a timer is started. The timer is
 reset each time the resource is received with a new TTL. If the resource is received with
 no TTL set, the timer is removed for the resource. Upon expiration of the timer, the
 configuration for the resource will be removed.
 The TTL can be refreshed or changed by sending a response that doesn't change the resource
 version. In this case the resource field does not need to be populated, which allows for
 light-weight "heartbeat" updates to keep a resource with a TTL alive.
 The TTL feature is meant to support configurations that should be removed in the event of
 a management server failure. For example, the feature may be used for fault injection
 testing where the fault injection should be terminated in the event that Envoy loses contact
 with the management server.
        .google.protobuf.Duration ttl = 6;

      • getTtlOrBuilder

        com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
         Time-to-live value for the resource. For each resource, a timer is started. The timer is
 reset each time the resource is received with a new TTL. If the resource is received with
 no TTL set, the timer is removed for the resource. Upon expiration of the timer, the
 configuration for the resource will be removed.
 The TTL can be refreshed or changed by sending a response that doesn't change the resource
 version. In this case the resource field does not need to be populated, which allows for
 light-weight "heartbeat" updates to keep a resource with a TTL alive.
 The TTL feature is meant to support configurations that should be removed in the event of
 a management server failure. For example, the feature may be used for fault injection
 testing where the fault injection should be terminated in the event that Envoy loses contact
 with the management server.
        .google.protobuf.Duration ttl = 6;

      • hasCacheControl

        boolean hasCacheControl()
         Cache control properties for the resource.
 [#not-implemented-hide:]
        .envoy.service.discovery.v3.Resource.CacheControl cache_control = 7;

      • getCacheControl

        Resource.CacheControl getCacheControl()
         Cache control properties for the resource.
 [#not-implemented-hide:]
        .envoy.service.discovery.v3.Resource.CacheControl cache_control = 7;

      • getCacheControlOrBuilder

        Resource.CacheControlOrBuilder getCacheControlOrBuilder()
         Cache control properties for the resource.
 [#not-implemented-hide:]
        .envoy.service.discovery.v3.Resource.CacheControl cache_control = 7;