ApiSpecificationRoute¶

class oci.apigateway.models.ApiSpecificationRoute(**kwargs)¶

Bases: object

A single route that forwards requests to a particular backend and may contain some additional policies.

Attributes

`METHODS_ANY`	A constant which can be used with the methods property of a ApiSpecificationRoute.
`METHODS_DELETE`	A constant which can be used with the methods property of a ApiSpecificationRoute.
`METHODS_GET`	A constant which can be used with the methods property of a ApiSpecificationRoute.
`METHODS_HEAD`	A constant which can be used with the methods property of a ApiSpecificationRoute.
`METHODS_OPTIONS`	A constant which can be used with the methods property of a ApiSpecificationRoute.
`METHODS_PATCH`	A constant which can be used with the methods property of a ApiSpecificationRoute.
`METHODS_POST`	A constant which can be used with the methods property of a ApiSpecificationRoute.
`METHODS_PUT`	A constant which can be used with the methods property of a ApiSpecificationRoute.
`backend`	[Required] Gets the backend of this ApiSpecificationRoute.
`logging_policies`	Gets the logging_policies of this ApiSpecificationRoute.
`methods`	Gets the methods of this ApiSpecificationRoute.
`path`	[Required] Gets the path of this ApiSpecificationRoute.
`request_policies`	Gets the request_policies of this ApiSpecificationRoute.
`response_policies`	Gets the response_policies of this ApiSpecificationRoute.

Methods

__init__(**kwargs) Initializes a new ApiSpecificationRoute object with values from keyword arguments.

METHODS_ANY = 'ANY'¶: A constant which can be used with the methods property of a ApiSpecificationRoute. This constant has a value of “ANY”

METHODS_DELETE = 'DELETE'¶: A constant which can be used with the methods property of a ApiSpecificationRoute. This constant has a value of “DELETE”

METHODS_GET = 'GET'¶: A constant which can be used with the methods property of a ApiSpecificationRoute. This constant has a value of “GET”

METHODS_HEAD = 'HEAD'¶: A constant which can be used with the methods property of a ApiSpecificationRoute. This constant has a value of “HEAD”

METHODS_OPTIONS = 'OPTIONS'¶: A constant which can be used with the methods property of a ApiSpecificationRoute. This constant has a value of “OPTIONS”

METHODS_PATCH = 'PATCH'¶: A constant which can be used with the methods property of a ApiSpecificationRoute. This constant has a value of “PATCH”

METHODS_POST = 'POST'¶: A constant which can be used with the methods property of a ApiSpecificationRoute. This constant has a value of “POST”

METHODS_PUT = 'PUT'¶: A constant which can be used with the methods property of a ApiSpecificationRoute. This constant has a value of “PUT”

__init__(**kwargs)¶

Initializes a new ApiSpecificationRoute object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

path (str) – The value to assign to the path property of this ApiSpecificationRoute.
methods (list[str]) – The value to assign to the methods property of this ApiSpecificationRoute. Allowed values for items in this list are: “ANY”, “HEAD”, “GET”, “POST”, “PUT”, “PATCH”, “DELETE”, “OPTIONS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
request_policies (oci.apigateway.models.ApiSpecificationRouteRequestPolicies) – The value to assign to the request_policies property of this ApiSpecificationRoute.
response_policies (oci.apigateway.models.ApiSpecificationRouteResponsePolicies) – The value to assign to the response_policies property of this ApiSpecificationRoute.
logging_policies (oci.apigateway.models.ApiSpecificationLoggingPolicies) – The value to assign to the logging_policies property of this ApiSpecificationRoute.
backend (oci.apigateway.models.ApiSpecificationRouteBackend) – The value to assign to the backend property of this ApiSpecificationRoute.

backend¶

[Required] Gets the backend of this ApiSpecificationRoute.

Returns:	The backend of this ApiSpecificationRoute.
Return type:	oci.apigateway.models.ApiSpecificationRouteBackend

logging_policies¶

Gets the logging_policies of this ApiSpecificationRoute.

Returns:	The logging_policies of this ApiSpecificationRoute.
Return type:	oci.apigateway.models.ApiSpecificationLoggingPolicies

methods¶

Gets the methods of this ApiSpecificationRoute. A list of allowed methods on this route.

Allowed values for items in this list are: “ANY”, “HEAD”, “GET”, “POST”, “PUT”, “PATCH”, “DELETE”, “OPTIONS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The methods of this ApiSpecificationRoute.
Return type:	list[str]

path¶

[Required] Gets the path of this ApiSpecificationRoute. A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.

Returns:	The path of this ApiSpecificationRoute.
Return type:	str

request_policies¶

Gets the request_policies of this ApiSpecificationRoute.

Returns:	The request_policies of this ApiSpecificationRoute.
Return type:	oci.apigateway.models.ApiSpecificationRouteRequestPolicies

response_policies¶

Gets the response_policies of this ApiSpecificationRoute.

Returns:	The response_policies of this ApiSpecificationRoute.
Return type:	oci.apigateway.models.ApiSpecificationRouteResponsePolicies