Class HttpRoute.RouteMatch (0.3.0)

public static final class HttpRoute.RouteMatch extends GeneratedMessageV3 implements HttpRoute.RouteMatchOrBuilder

RouteMatch defines specifications used to match requests. If multiple match types are set, this RouteMatch will match if ALL type of matches are matched.

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

Static Fields

FULL_PATH_MATCH_FIELD_NUMBER

public static final int FULL_PATH_MATCH_FIELD_NUMBER
Field Value
Type Description
int

HEADERS_FIELD_NUMBER

public static final int HEADERS_FIELD_NUMBER
Field Value
Type Description
int

IGNORE_CASE_FIELD_NUMBER

public static final int IGNORE_CASE_FIELD_NUMBER
Field Value
Type Description
int

PREFIX_MATCH_FIELD_NUMBER

public static final int PREFIX_MATCH_FIELD_NUMBER
Field Value
Type Description
int

QUERY_PARAMETERS_FIELD_NUMBER

public static final int QUERY_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

REGEX_MATCH_FIELD_NUMBER

public static final int REGEX_MATCH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(HttpRoute.RouteMatch prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getFullPathMatch()

public String getFullPathMatch()

The HTTP request path value should exactly match this value.

Only one of full_path_match, prefix_match, or regex_match should be used.

string full_path_match = 1;

Returns
Type Description
String

The fullPathMatch.

getFullPathMatchBytes()

public ByteString getFullPathMatchBytes()

The HTTP request path value should exactly match this value.

Only one of full_path_match, prefix_match, or regex_match should be used.

string full_path_match = 1;

Returns
Type Description
ByteString

The bytes for fullPathMatch.

getHeaders(int index)

public HttpRoute.HeaderMatch getHeaders(int index)

Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.HeaderMatch headers = 5;

Parameter
Name Description
index int
Returns
Type Description
HttpRoute.HeaderMatch

getHeadersCount()

public int getHeadersCount()

Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.HeaderMatch headers = 5;

Returns
Type Description
int

getHeadersList()

public List<HttpRoute.HeaderMatch> getHeadersList()

Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.HeaderMatch headers = 5;

Returns
Type Description
List<HeaderMatch>

getHeadersOrBuilder(int index)

public HttpRoute.HeaderMatchOrBuilder getHeadersOrBuilder(int index)

Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.HeaderMatch headers = 5;

Parameter
Name Description
index int
Returns
Type Description
HttpRoute.HeaderMatchOrBuilder

getHeadersOrBuilderList()

public List<? extends HttpRoute.HeaderMatchOrBuilder> getHeadersOrBuilderList()

Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.HeaderMatch headers = 5;

Returns
Type Description
List<? extends com.google.cloud.networkservices.v1.HttpRoute.HeaderMatchOrBuilder>

getIgnoreCase()

public boolean getIgnoreCase()

Specifies if prefix_match and full_path_match matches are case sensitive. The default value is false.

bool ignore_case = 4;

Returns
Type Description
boolean

The ignoreCase.

getParserForType()

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

getPathMatchCase()

public HttpRoute.RouteMatch.PathMatchCase getPathMatchCase()
Returns
Type Description
HttpRoute.RouteMatch.PathMatchCase

getPrefixMatch()

public String getPrefixMatch()

The HTTP request path value must begin with specified prefix_match. prefix_match must begin with a /.

Only one of full_path_match, prefix_match, or regex_match should be used.

string prefix_match = 2;

Returns
Type Description
String

The prefixMatch.

getPrefixMatchBytes()

public ByteString getPrefixMatchBytes()

The HTTP request path value must begin with specified prefix_match. prefix_match must begin with a /.

Only one of full_path_match, prefix_match, or regex_match should be used.

string prefix_match = 2;

Returns
Type Description
ByteString

The bytes for prefixMatch.

getQueryParameters(int index)

public HttpRoute.QueryParameterMatch getQueryParameters(int index)

Specifies a list of query parameters to match against. ALL of the query parameters must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.QueryParameterMatch query_parameters = 6;

Parameter
Name Description
index int
Returns
Type Description
HttpRoute.QueryParameterMatch

getQueryParametersCount()

public int getQueryParametersCount()

Specifies a list of query parameters to match against. ALL of the query parameters must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.QueryParameterMatch query_parameters = 6;

Returns
Type Description
int

getQueryParametersList()

public List<HttpRoute.QueryParameterMatch> getQueryParametersList()

Specifies a list of query parameters to match against. ALL of the query parameters must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.QueryParameterMatch query_parameters = 6;

Returns
Type Description
List<QueryParameterMatch>

getQueryParametersOrBuilder(int index)

public HttpRoute.QueryParameterMatchOrBuilder getQueryParametersOrBuilder(int index)

Specifies a list of query parameters to match against. ALL of the query parameters must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.QueryParameterMatch query_parameters = 6;

Parameter
Name Description
index int
Returns
Type Description
HttpRoute.QueryParameterMatchOrBuilder

getQueryParametersOrBuilderList()

public List<? extends HttpRoute.QueryParameterMatchOrBuilder> getQueryParametersOrBuilderList()

Specifies a list of query parameters to match against. ALL of the query parameters must be matched.

repeated .google.cloud.networkservices.v1.HttpRoute.QueryParameterMatch query_parameters = 6;

Returns
Type Description
List<? extends com.google.cloud.networkservices.v1.HttpRoute.QueryParameterMatchOrBuilder>

getRegexMatch()

public String getRegexMatch()

The HTTP request path value must satisfy the regular expression specified by regex_match after removing any query parameters and anchor supplied with the original URL. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax

Only one of full_path_match, prefix_match, or regex_match should be used.

string regex_match = 3;

Returns
Type Description
String

The regexMatch.

getRegexMatchBytes()

public ByteString getRegexMatchBytes()

The HTTP request path value must satisfy the regular expression specified by regex_match after removing any query parameters and anchor supplied with the original URL. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax

Only one of full_path_match, prefix_match, or regex_match should be used.

string regex_match = 3;

Returns
Type Description
ByteString

The bytes for regexMatch.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasFullPathMatch()

public boolean hasFullPathMatch()

The HTTP request path value should exactly match this value.

Only one of full_path_match, prefix_match, or regex_match should be used.

string full_path_match = 1;

Returns
Type Description
boolean

Whether the fullPathMatch field is set.

hasPrefixMatch()

public boolean hasPrefixMatch()

The HTTP request path value must begin with specified prefix_match. prefix_match must begin with a /.

Only one of full_path_match, prefix_match, or regex_match should be used.

string prefix_match = 2;

Returns
Type Description
boolean

Whether the prefixMatch field is set.

hasRegexMatch()

public boolean hasRegexMatch()

The HTTP request path value must satisfy the regular expression specified by regex_match after removing any query parameters and anchor supplied with the original URL. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax

Only one of full_path_match, prefix_match, or regex_match should be used.

string regex_match = 3;

Returns
Type Description
boolean

Whether the regexMatch 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.RouteMatch.Builder newBuilderForType()
Returns
Type Description
HttpRoute.RouteMatch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpRoute.RouteMatch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HttpRoute.RouteMatch.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.RouteMatch.Builder toBuilder()
Returns
Type Description
HttpRoute.RouteMatch.Builder

writeTo(CodedOutputStream output)

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