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
Modifier and TypeMethodDescriptiongetAliases
(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
The aliases are a list of other names that this resource can go by.The aliases are a list of other names that this resource can go by.Cache control properties for the resource.Cache control properties for the resource.The Metadata field can be used to provide additional information for the resource.The Metadata field can be used to provide additional information for the resource.getName()
The resource's name, to distinguish it from others of the same type of resource.com.google.protobuf.ByteString
The resource's name, to distinguish it from others of the same type of resource.com.google.protobuf.Any
The resource being tracked.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.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
The resource being tracked.com.google.protobuf.Duration
getTtl()
Time-to-live value for the resource.com.google.protobuf.DurationOrBuilder
Time-to-live value for the resource.The resource level version.com.google.protobuf.ByteString
The resource level version.boolean
Cache control properties for the resource.boolean
The Metadata field can be used to provide additional information for the resource.boolean
The resource being tracked.boolean
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.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 Details
-
getName
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;
- Returns:
- The name.
-
getNameBytes
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;
- Returns:
- The bytes for name.
-
hasResourceName
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;
- Returns:
- Whether the resourceName field is set.
-
getResourceName
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;
- Returns:
- The resourceName.
-
getResourceNameOrBuilder
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;
-
getAliasesList
The aliases are a list of other names that this resource can go by.
repeated string aliases = 4;
- Returns:
- A list containing the aliases.
-
getAliasesCount
int getAliasesCount()The aliases are a list of other names that this resource can go by.
repeated string aliases = 4;
- Returns:
- The count of aliases.
-
getAliases
The aliases are a list of other names that this resource can go by.
repeated string aliases = 4;
- Parameters:
index
- The index of the element to return.- Returns:
- The aliases at the given index.
-
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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the aliases at the given index.
-
getVersion
String getVersion()The resource level version. It allows xDS to track the state of individual resources.
string version = 1;
- Returns:
- The version.
-
getVersionBytes
com.google.protobuf.ByteString getVersionBytes()The resource level version. It allows xDS to track the state of individual resources.
string version = 1;
- Returns:
- The bytes for version.
-
hasResource
boolean hasResource()The resource being tracked.
.google.protobuf.Any resource = 2;
- Returns:
- Whether the resource field is set.
-
getResource
com.google.protobuf.Any getResource()The resource being tracked.
.google.protobuf.Any resource = 2;
- Returns:
- The resource.
-
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;
- Returns:
- Whether the ttl field is set.
-
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;
- Returns:
- The ttl.
-
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;
- Returns:
- Whether the cacheControl field is set.
-
getCacheControl
Resource.CacheControl getCacheControl()Cache control properties for the resource. [#not-implemented-hide:]
.envoy.service.discovery.v3.Resource.CacheControl cache_control = 7;
- Returns:
- The cacheControl.
-
getCacheControlOrBuilder
Resource.CacheControlOrBuilder getCacheControlOrBuilder()Cache control properties for the resource. [#not-implemented-hide:]
.envoy.service.discovery.v3.Resource.CacheControl cache_control = 7;
-
hasMetadata
boolean hasMetadata()The Metadata field can be used to provide additional information for the resource. E.g. the trace data for debugging.
.envoy.config.core.v3.Metadata metadata = 9;
- Returns:
- Whether the metadata field is set.
-
getMetadata
Metadata getMetadata()The Metadata field can be used to provide additional information for the resource. E.g. the trace data for debugging.
.envoy.config.core.v3.Metadata metadata = 9;
- Returns:
- The metadata.
-
getMetadataOrBuilder
MetadataOrBuilder getMetadataOrBuilder()The Metadata field can be used to provide additional information for the resource. E.g. the trace data for debugging.
.envoy.config.core.v3.Metadata metadata = 9;
-