Class HttpRoute.Destination (0.24.0) 

public static final class HttpRoute.Destination extends GeneratedMessageV3 implements HttpRoute.DestinationOrBuilder

Specifications of a destination to which the request should be routed to.

Protobuf type google.cloud.networkservices.v1.HttpRoute.Destination

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HttpRoute.Destination

Static Fields

REQUEST_HEADER_MODIFIER_FIELD_NUMBER

public static final int REQUEST_HEADER_MODIFIER_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_HEADER_MODIFIER_FIELD_NUMBER

public static final int RESPONSE_HEADER_MODIFIER_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_NAME_FIELD_NUMBER

public static final int SERVICE_NAME_FIELD_NUMBER
Field Value
Type Description
int

WEIGHT_FIELD_NUMBER

public static final int WEIGHT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HttpRoute.Destination getDefaultInstance()
Returns
Type Description
HttpRoute.Destination

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HttpRoute.Destination.Builder newBuilder()
Returns
Type Description
HttpRoute.Destination.Builder

newBuilder(HttpRoute.Destination prototype)

public static HttpRoute.Destination.Builder newBuilder(HttpRoute.Destination prototype)
Parameter
Name Description
prototype HttpRoute.Destination
Returns
Type Description
HttpRoute.Destination.Builder

parseDelimitedFrom(InputStream input)

public static HttpRoute.Destination parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.Destination parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HttpRoute.Destination parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.Destination parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpRoute.Destination parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.Destination parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpRoute.Destination parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.Destination parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HttpRoute.Destination parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.Destination parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HttpRoute.Destination parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.Destination parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HttpRoute.Destination> parser()
Returns
Type Description
Parser<Destination>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public HttpRoute.Destination getDefaultInstanceForType()
Returns
Type Description
HttpRoute.Destination

getParserForType()

public Parser<HttpRoute.Destination> getParserForType()
Returns
Type Description
Parser<Destination>
Overrides

getRequestHeaderModifier()

public HttpRoute.HeaderModifier getRequestHeaderModifier()

Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.

.google.cloud.networkservices.v1.HttpRoute.HeaderModifier request_header_modifier = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HttpRoute.HeaderModifier

The requestHeaderModifier.

getRequestHeaderModifierOrBuilder()

public HttpRoute.HeaderModifierOrBuilder getRequestHeaderModifierOrBuilder()

Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.

.google.cloud.networkservices.v1.HttpRoute.HeaderModifier request_header_modifier = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HttpRoute.HeaderModifierOrBuilder

getResponseHeaderModifier()

public HttpRoute.HeaderModifier getResponseHeaderModifier()

Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.

.google.cloud.networkservices.v1.HttpRoute.HeaderModifier response_header_modifier = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HttpRoute.HeaderModifier

The responseHeaderModifier.

getResponseHeaderModifierOrBuilder()

public HttpRoute.HeaderModifierOrBuilder getResponseHeaderModifierOrBuilder()

Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.

.google.cloud.networkservices.v1.HttpRoute.HeaderModifier response_header_modifier = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HttpRoute.HeaderModifierOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceName()

public String getServiceName()

The URL of a BackendService to route traffic to.

string service_name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The serviceName.

getServiceNameBytes()

public ByteString getServiceNameBytes()

The URL of a BackendService to route traffic to.

string service_name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for serviceName.

getWeight()

public int getWeight()

Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as:

  • weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports.

    If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend.

    If weights are specified for any one service name, they need to be specified for all of them.

    If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.

int32 weight = 2;

Returns
Type Description
int

The weight.

hasRequestHeaderModifier()

public boolean hasRequestHeaderModifier()

Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.

.google.cloud.networkservices.v1.HttpRoute.HeaderModifier request_header_modifier = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the requestHeaderModifier field is set.

hasResponseHeaderModifier()

public boolean hasResponseHeaderModifier()

Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.

.google.cloud.networkservices.v1.HttpRoute.HeaderModifier response_header_modifier = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the responseHeaderModifier field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HttpRoute.Destination.Builder newBuilderForType()
Returns
Type Description
HttpRoute.Destination.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpRoute.Destination.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HttpRoute.Destination.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HttpRoute.Destination.Builder toBuilder()
Returns
Type Description
HttpRoute.Destination.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException