ApiConfigSource (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.config.core.v3.ApiConfigSource

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ApiConfigSourceOrBuilder, Serializable
```
public final class ApiConfigSource
extends com.google.protobuf.GeneratedMessageV3
implements ApiConfigSourceOrBuilder
```
```
 API configuration source. This identifies the API type and cluster that Envoy
 will use to fetch an xDS API.
 [#next-free-field: 9]
 
```
Protobuf type envoy.config.core.v3.ApiConfigSource
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ApiConfigSource.ApiType` APIs may be fetched via either REST or gRPC.
`static class`	`ApiConfigSource.Builder` API configuration source.

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`API_TYPE_FIELD_NUMBER`
`static int`	`CLUSTER_NAMES_FIELD_NUMBER`
`static int`	`GRPC_SERVICES_FIELD_NUMBER`
`static int`	`RATE_LIMIT_SETTINGS_FIELD_NUMBER`
`static int`	`REFRESH_DELAY_FIELD_NUMBER`
`static int`	`REQUEST_TIMEOUT_FIELD_NUMBER`
`static int`	`SET_NODE_ON_FIRST_MESSAGE_ONLY_FIELD_NUMBER`
`static int`	`TRANSPORT_API_VERSION_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`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.
`com.google.protobuf.ProtocolStringList`	`getClusterNamesList()` Cluster names should be used only with REST.
`static ApiConfigSource`	`getDefaultInstance()`
`ApiConfigSource`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<ApiConfigSource>`	`getParserForType()`
`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.
`int`	`getSerializedSize()`
`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.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static ApiConfigSource.Builder`	`newBuilder()`
`static ApiConfigSource.Builder`	`newBuilder(ApiConfigSource prototype)`
`ApiConfigSource.Builder`	`newBuilderForType()`
`protected ApiConfigSource.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static ApiConfigSource`	`parseDelimitedFrom(InputStream input)`
`static ApiConfigSource`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ApiConfigSource`	`parseFrom(byte[] data)`
`static ApiConfigSource`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ApiConfigSource`	`parseFrom(ByteBuffer data)`
`static ApiConfigSource`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ApiConfigSource`	`parseFrom(com.google.protobuf.ByteString data)`
`static ApiConfigSource`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ApiConfigSource`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static ApiConfigSource`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ApiConfigSource`	`parseFrom(InputStream input)`
`static ApiConfigSource`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<ApiConfigSource>`	`parser()`
`ApiConfigSource.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, 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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- API_TYPE_FIELD_NUMBER
```
public static final int API_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRANSPORT_API_VERSION_FIELD_NUMBER
```
public static final int TRANSPORT_API_VERSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CLUSTER_NAMES_FIELD_NUMBER
```
public static final int CLUSTER_NAMES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- GRPC_SERVICES_FIELD_NUMBER
```
public static final int GRPC_SERVICES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REFRESH_DELAY_FIELD_NUMBER
```
public static final int REFRESH_DELAY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REQUEST_TIMEOUT_FIELD_NUMBER
```
public static final int REQUEST_TIMEOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RATE_LIMIT_SETTINGS_FIELD_NUMBER
```
public static final int RATE_LIMIT_SETTINGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SET_NODE_ON_FIRST_MESSAGE_ONLY_FIELD_NUMBER
```
public static final int SET_NODE_ON_FIRST_MESSAGE_ONLY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

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

getApiTypeValue
```
public int getApiTypeValue()
```
```
 API type (gRPC, REST, delta gRPC)
 
```
.envoy.config.core.v3.ApiConfigSource.ApiType api_type = 1 [(.validate.rules) = { ... }
Specified by:

getApiTypeValue in interface ApiConfigSourceOrBuilder

getApiType
```
public ApiConfigSource.ApiType getApiType()
```
```
 API type (gRPC, REST, delta gRPC)
 
```
.envoy.config.core.v3.ApiConfigSource.ApiType api_type = 1 [(.validate.rules) = { ... }
Specified by:

getApiType in interface ApiConfigSourceOrBuilder

getTransportApiVersionValue

public 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) = { ... }

Specified by:: getTransportApiVersionValue in interface ApiConfigSourceOrBuilder

getTransportApiVersion

public 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) = { ... }

Specified by:: getTransportApiVersion in interface ApiConfigSourceOrBuilder

getClusterNamesList

public com.google.protobuf.ProtocolStringList 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;

Specified by:: getClusterNamesList in interface ApiConfigSourceOrBuilder

getClusterNamesCount

public 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;

Specified by:: getClusterNamesCount in interface ApiConfigSourceOrBuilder

getClusterNames

public 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;

Specified by:: getClusterNames in interface ApiConfigSourceOrBuilder

getClusterNamesBytes

public 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;

Specified by:: getClusterNamesBytes in interface ApiConfigSourceOrBuilder