Package com.google.api

Enum BackendRule.PathTranslation

java.lang.Object

java.lang.Enum<BackendRule.PathTranslation>

com.google.api.BackendRule.PathTranslation

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<BackendRule.PathTranslation>

Enclosing class:

BackendRule

public static enum BackendRule.PathTranslation
extends Enum<BackendRule.PathTranslation>
implements com.google.protobuf.ProtocolMessageEnum

 Path Translation specifies how to combine the backend address with the
 request path in order to produce the appropriate forwarding URL for the
 request.

 Path Translation is applicable only to HTTP-based backends. Backends which
 do not accept requests over HTTP/HTTPS should leave `path_translation`
 unspecified.
 

Protobuf enum google.api.BackendRule.PathTranslation

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPEND_PATH_TO_ADDRESS	The request path will be appended to the backend address
CONSTANT_ADDRESS	Use the backend address as-is, with no modification to the path.
PATH_TRANSLATION_UNSPECIFIED	PATH_TRANSLATION_UNSPECIFIED = 0;
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static final int	APPEND_PATH_TO_ADDRESS_VALUE	The request path will be appended to the backend address
static final int	CONSTANT_ADDRESS_VALUE	Use the backend address as-is, with no modification to the path.
static final int	PATH_TRANSLATION_UNSPECIFIED_VALUE	PATH_TRANSLATION_UNSPECIFIED = 0;

Method Summary

Modifier and Type	Method	Description
static BackendRule.PathTranslation	forNumber(int value)
static final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
final int	getNumber()
final com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<BackendRule.PathTranslation>	internalGetValueMap()
static BackendRule.PathTranslation	valueOf(int value)	Deprecated.
static BackendRule.PathTranslation	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static BackendRule.PathTranslation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BackendRule.PathTranslation[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PATH_TRANSLATION_UNSPECIFIED

public static final BackendRule.PathTranslation PATH_TRANSLATION_UNSPECIFIED

PATH_TRANSLATION_UNSPECIFIED = 0;

CONSTANT_ADDRESS

public static final BackendRule.PathTranslation CONSTANT_ADDRESS

 Use the backend address as-is, with no modification to the path. If the
 URL pattern contains variables, the variable names and values will be
 appended to the query string. If a query string parameter and a URL
 pattern variable have the same name, this may result in duplicate keys in
 the query string.

 # Examples

 Given the following operation config:

     Method path:        /api/company/{cid}/user/{uid}
     Backend address:    https://example.cloudfunctions.net/getUser

 Requests to the following request paths will call the backend at the
 translated path:

     Request path: /api/company/widgetworks/user/johndoe
     Translated:
     https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe

     Request path: /api/company/widgetworks/user/johndoe?timezone=EST
     Translated:
     https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe
 

CONSTANT_ADDRESS = 1;

APPEND_PATH_TO_ADDRESS

public static final BackendRule.PathTranslation APPEND_PATH_TO_ADDRESS

 The request path will be appended to the backend address.

 # Examples

 Given the following operation config:

     Method path:        /api/company/{cid}/user/{uid}
     Backend address:    https://example.appspot.com

 Requests to the following request paths will call the backend at the
 translated path:

     Request path: /api/company/widgetworks/user/johndoe
     Translated:
     https://example.appspot.com/api/company/widgetworks/user/johndoe

     Request path: /api/company/widgetworks/user/johndoe?timezone=EST
     Translated:
     https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST
 

APPEND_PATH_TO_ADDRESS = 2;

UNRECOGNIZED

public static final BackendRule.PathTranslation UNRECOGNIZED

Field Details

PATH_TRANSLATION_UNSPECIFIED_VALUE

public static final int PATH_TRANSLATION_UNSPECIFIED_VALUE

PATH_TRANSLATION_UNSPECIFIED = 0;

See Also:

• Constant Field Values

CONSTANT_ADDRESS_VALUE

public static final int CONSTANT_ADDRESS_VALUE

 Use the backend address as-is, with no modification to the path. If the
 URL pattern contains variables, the variable names and values will be
 appended to the query string. If a query string parameter and a URL
 pattern variable have the same name, this may result in duplicate keys in
 the query string.

 # Examples

 Given the following operation config:

     Method path:        /api/company/{cid}/user/{uid}
     Backend address:    https://example.cloudfunctions.net/getUser

 Requests to the following request paths will call the backend at the
 translated path:

     Request path: /api/company/widgetworks/user/johndoe
     Translated:
     https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe

     Request path: /api/company/widgetworks/user/johndoe?timezone=EST
     Translated:
     https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe
 

CONSTANT_ADDRESS = 1;

See Also:

• Constant Field Values

APPEND_PATH_TO_ADDRESS_VALUE

public static final int APPEND_PATH_TO_ADDRESS_VALUE

 The request path will be appended to the backend address.

 # Examples

 Given the following operation config:

     Method path:        /api/company/{cid}/user/{uid}
     Backend address:    https://example.appspot.com

 Requests to the following request paths will call the backend at the
 translated path:

     Request path: /api/company/widgetworks/user/johndoe
     Translated:
     https://example.appspot.com/api/company/widgetworks/user/johndoe

     Request path: /api/company/widgetworks/user/johndoe?timezone=EST
     Translated:
     https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST
 

APPEND_PATH_TO_ADDRESS = 2;

See Also:

• Constant Field Values

Method Details

values

public static BackendRule.PathTranslation[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BackendRule.PathTranslation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static BackendRule.PathTranslation valueOf(int value)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

value - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

forNumber

public static BackendRule.PathTranslation forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<BackendRule.PathTranslation> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static BackendRule.PathTranslation valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

desc - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null