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

Class Resource

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ResourceOrBuilder, Serializable
    public final class Resource
extends com.google.protobuf.GeneratedMessageV3
implements ResourceOrBuilder
     [#next-free-field: 9]
    Protobuf type envoy.service.discovery.v3.Resource
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Resource.Builder
      [#next-free-field: 9]
      static class  Resource.CacheControl
      Cache control properties for the resource.
      static interface  Resource.CacheControlOrBuilder  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      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.
      com.google.protobuf.ProtocolStringList 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.
      static Resource getDefaultInstance()  
      Resource getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      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.Parser<Resource> getParserForType()  
      com.google.protobuf.Any getResource()
      The resource being tracked.
      ResourceName getResourceName()
      Alternative to the ``name`` field, to be used when the server supports multiple variants of the named resource that are differentiated by dynamic parameter constraints.
      ResourceNameOrBuilder getResourceNameOrBuilder()
      Alternative to the ``name`` field, to be used when the server supports multiple variants of the named resource that are differentiated by dynamic parameter constraints.
      com.google.protobuf.AnyOrBuilder getResourceOrBuilder()
      The resource being tracked.
      int getSerializedSize()  
      com.google.protobuf.Duration getTtl()
      Time-to-live value for the resource.
      com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
      Time-to-live value for the resource.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      String getVersion()
      The resource level version.
      com.google.protobuf.ByteString getVersionBytes()
      The resource level version.
      boolean hasCacheControl()
      Cache control properties for the resource.
      int hashCode()  
      boolean hasResource()
      The resource being tracked.
      boolean hasResourceName()
      Alternative to the ``name`` field, to be used when the server supports multiple variants of the named resource that are differentiated by dynamic parameter constraints.
      boolean hasTtl()
      Time-to-live value for the resource.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Resource.Builder newBuilder()  
      static Resource.Builder newBuilder​(Resource prototype)  
      Resource.Builder newBuilderForType()  
      protected Resource.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Resource parseDelimitedFrom​(InputStream input)  
      static Resource parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Resource parseFrom​(byte[] data)  
      static Resource parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Resource parseFrom​(com.google.protobuf.ByteString data)  
      static Resource parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Resource parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Resource parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Resource parseFrom​(InputStream input)  
      static Resource parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Resource parseFrom​(ByteBuffer data)  
      static Resource parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Resource> parser()  
      Resource.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • 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, hasField, hasOneof

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         The resource's name, to distinguish it from others of the same type of resource.
 Only one of ``name`` or ``resource_name`` may be set.
        string name = 3;
        Specified by:
        getName in interface ResourceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource's name, to distinguish it from others of the same type of resource.
 Only one of ``name`` or ``resource_name`` may be set.
        string name = 3;
        Specified by:
        getNameBytes in interface ResourceOrBuilder
        Returns:
        The bytes for name.

      • hasResourceName

        public boolean hasResourceName()
         Alternative to the ``name`` field, to be used when the server supports
 multiple variants of the named resource that are differentiated by
 dynamic parameter constraints.
 Only one of ``name`` or ``resource_name`` may be set.
        .envoy.service.discovery.v3.ResourceName resource_name = 8;
        Specified by:
        hasResourceName in interface ResourceOrBuilder
        Returns:
        Whether the resourceName field is set.

      • getResourceName

        public ResourceName getResourceName()
         Alternative to the ``name`` field, to be used when the server supports
 multiple variants of the named resource that are differentiated by
 dynamic parameter constraints.
 Only one of ``name`` or ``resource_name`` may be set.
        .envoy.service.discovery.v3.ResourceName resource_name = 8;
        Specified by:
        getResourceName in interface ResourceOrBuilder
        Returns:
        The resourceName.

      • getResourceNameOrBuilder

        public ResourceNameOrBuilder getResourceNameOrBuilder()
         Alternative to the ``name`` field, to be used when the server supports
 multiple variants of the named resource that are differentiated by
 dynamic parameter constraints.
 Only one of ``name`` or ``resource_name`` may be set.
        .envoy.service.discovery.v3.ResourceName resource_name = 8;
        Specified by:
        getResourceNameOrBuilder in interface ResourceOrBuilder

      • getAliasesList

        public com.google.protobuf.ProtocolStringList getAliasesList()
         The aliases are a list of other names that this resource can go by.
        repeated string aliases = 4;
        Specified by:
        getAliasesList in interface ResourceOrBuilder
        Returns:
        A list containing the aliases.

      • getAliasesCount

        public int getAliasesCount()
         The aliases are a list of other names that this resource can go by.
        repeated string aliases = 4;
        Specified by:
        getAliasesCount in interface ResourceOrBuilder
        Returns:
        The count of aliases.

      • getAliases

        public String getAliases​(int index)
         The aliases are a list of other names that this resource can go by.
        repeated string aliases = 4;
        Specified by:
        getAliases in interface ResourceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The aliases at the given index.

      • getAliasesBytes

        public 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;
        Specified by:
        getAliasesBytes in interface ResourceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the aliases at the given index.

      • getVersion

        public String getVersion()
         The resource level version. It allows xDS to track the state of individual
 resources.
        string version = 1;
        Specified by:
        getVersion in interface ResourceOrBuilder
        Returns:
        The version.

      • getVersionBytes

        public com.google.protobuf.ByteString getVersionBytes()
         The resource level version. It allows xDS to track the state of individual
 resources.
        string version = 1;
        Specified by:
        getVersionBytes in interface ResourceOrBuilder
        Returns:
        The bytes for version.

      • hasResource

        public boolean hasResource()
         The resource being tracked.
        .google.protobuf.Any resource = 2;
        Specified by:
        hasResource in interface ResourceOrBuilder
        Returns:
        Whether the resource field is set.

      • getResource

        public com.google.protobuf.Any getResource()
         The resource being tracked.
        .google.protobuf.Any resource = 2;
        Specified by:
        getResource in interface ResourceOrBuilder
        Returns:
        The resource.

      • getResourceOrBuilder

        public com.google.protobuf.AnyOrBuilder getResourceOrBuilder()
         The resource being tracked.
        .google.protobuf.Any resource = 2;
        Specified by:
        getResourceOrBuilder in interface ResourceOrBuilder

      • hasTtl

        public 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;
        Specified by:
        hasTtl in interface ResourceOrBuilder
        Returns:
        Whether the ttl field is set.

      • getTtl

        public 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;
        Specified by:
        getTtl in interface ResourceOrBuilder
        Returns:
        The ttl.

      • getTtlOrBuilder

        public 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;
        Specified by:
        getTtlOrBuilder in interface ResourceOrBuilder

      • hasCacheControl

        public boolean hasCacheControl()
         Cache control properties for the resource.
 [#not-implemented-hide:]
        .envoy.service.discovery.v3.Resource.CacheControl cache_control = 7;
        Specified by:
        hasCacheControl in interface ResourceOrBuilder
        Returns:
        Whether the cacheControl field is set.

      • getCacheControl

        public Resource.CacheControl getCacheControl()
         Cache control properties for the resource.
 [#not-implemented-hide:]
        .envoy.service.discovery.v3.Resource.CacheControl cache_control = 7;
        Specified by:
        getCacheControl in interface ResourceOrBuilder
        Returns:
        The cacheControl.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Resource parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Resource parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Resource parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Resource parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Resource parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Resource parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Resource parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Resource.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Resource.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Resource.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Resource getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Resource> parser()

      • getParserForType

        public com.google.protobuf.Parser<Resource> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Resource getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder