HttpRoute_RouteAction class

The specifications for routing traffic and applying associated policies.

Inheritance
  • Object
  • GeneratedMessage
  • HttpRoute_RouteAction

Constructors

HttpRoute_RouteAction({Iterable<HttpRoute_Destination>? destinations, HttpRoute_Redirect? redirect, HttpRoute_FaultInjectionPolicy? faultInjectionPolicy, HttpRoute_HeaderModifier? requestHeaderModifier, HttpRoute_HeaderModifier? responseHeaderModifier, HttpRoute_URLRewrite? urlRewrite, Duration? timeout, HttpRoute_RetryPolicy? retryPolicy, HttpRoute_RequestMirrorPolicy? requestMirrorPolicy, HttpRoute_CorsPolicy? corsPolicy})
factory
HttpRoute_RouteAction.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
HttpRoute_RouteAction.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

corsPolicy HttpRoute_CorsPolicy
The specification for allowing client side cross-origin requests.
getter/setter pair
destinations List<HttpRoute_Destination>
The destination to which traffic should be forwarded.
no setter
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
faultInjectionPolicy HttpRoute_FaultInjectionPolicy
The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted for a percentage of requests.
getter/setter pair
hashCode int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
isFrozen bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
redirect HttpRoute_Redirect
If set, the request is directed as configured by this field.
getter/setter pair
requestHeaderModifier HttpRoute_HeaderModifier
The specification for modifying the headers of a matching request prior to delivery of the request to the destination.
getter/setter pair
requestMirrorPolicy HttpRoute_RequestMirrorPolicy
Specifies the policy on how requests intended for the routes destination are shadowed to a separate mirrored destination. Proxy will not wait for the shadow destination to respond before returning the response. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.
getter/setter pair
responseHeaderModifier HttpRoute_HeaderModifier
The specification for modifying the headers of a response prior to sending the response back to the client.
getter/setter pair
retryPolicy HttpRoute_RetryPolicy
Specifies the retry policy associated with this route.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
timeout Duration
Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
urlRewrite HttpRoute_URLRewrite
The specification for rewrite URL before forwarding requests to the destination.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearCorsPolicy() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearFaultInjectionPolicy() → void
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearRedirect() → void
clearRequestHeaderModifier() → void
clearRequestMirrorPolicy() → void
clearResponseHeaderModifier() → void
clearRetryPolicy() → void
clearTimeout() → void
clearUrlRewrite() → void
clone() HttpRoute_RouteAction
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(HttpRoute_RouteAction)) HttpRoute_RouteAction
Apply updates to a copy of this message.
override
createEmptyInstance() HttpRoute_RouteAction
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) List<T>
Creates List implementing a mutable repeated field.
inherited
ensureCorsPolicy() HttpRoute_CorsPolicy
ensureFaultInjectionPolicy() HttpRoute_FaultInjectionPolicy
ensureRedirect() HttpRoute_Redirect
ensureRequestHeaderModifier() HttpRoute_HeaderModifier
ensureRequestMirrorPolicy() HttpRoute_RequestMirrorPolicy
ensureResponseHeaderModifier() HttpRoute_HeaderModifier
ensureRetryPolicy() HttpRoute_RetryPolicy
ensureTimeout() Duration
ensureUrlRewrite() HttpRoute_URLRewrite
extensionsAreInitialized() bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) int?
inherited
hasCorsPolicy() bool
hasExtension(Extension extension) bool
Returns true if a value of extension is present.
inherited
hasFaultInjectionPolicy() bool
hasField(int tagNumber) bool
Whether this message has a field associated with tagNumber.
inherited
hasRedirect() bool
hasRequestHeaderModifier() bool
hasRequestMirrorPolicy() bool
hasRequiredFields() bool
Whether the message has required fields.
inherited
hasResponseHeaderModifier() bool
hasRetryPolicy() bool
hasTimeout() bool
hasUrlRewrite() bool
isInitialized() bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() String
Returns a String representation of this message.
inherited
writeToBuffer() Uint8List
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
inherited
writeToJson() String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited