RedirectClient

class oci.waas.RedirectClient(config, **kwargs)

OCI Web Application Acceleration and Security Services

Methods

__init__(config, **kwargs) Creates a new service client
change_http_redirect_compartment(…) Moves HTTP Redirect into a different compartment.
create_http_redirect(…) Creates a new HTTP Redirect on the WAF edge.
delete_http_redirect(http_redirect_id, **kwargs) Deletes a redirect.
get_http_redirect(http_redirect_id, **kwargs) Gets the details of a HTTP Redirect.
list_http_redirects(compartment_id, **kwargs) Gets a list of HTTP Redirects.
update_http_redirect(http_redirect_id, …) Updates the details of a HTTP Redirect, including target and tags.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

change_http_redirect_compartment(http_redirect_id, change_http_redirect_compartment_details, **kwargs)

Moves HTTP Redirect into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.

Parameters:
  • http_redirect_id (str) –

    (required) The OCID of the HTTP Redirect.

  • change_http_redirect_compartment_details (ChangeHttpRedirectCompartmentDetails) – (required)
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag provided matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations Example: If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

create_http_redirect(create_http_redirect_details, **kwargs)

Creates a new HTTP Redirect on the WAF edge.

Parameters:
  • create_http_redirect_details (CreateHttpRedirectDetails) – (required) The details of the HTTP Redirect.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations Example: If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_http_redirect(http_redirect_id, **kwargs)

Deletes a redirect.

Parameters:
  • http_redirect_id (str) –

    (required) The OCID of the HTTP Redirect.

  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations Example: If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag provided matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

get_http_redirect(http_redirect_id, **kwargs)

Gets the details of a HTTP Redirect.

Parameters:
  • http_redirect_id (str) –

    (required) The OCID of the HTTP Redirect.

  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type HttpRedirect

Return type:

Response

list_http_redirects(compartment_id, **kwargs)

Gets a list of HTTP Redirects.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment. This number is generated when the compartment is created.

  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) – (optional) The maximum number of items to return in a paginated call. If unspecified, defaults to 10.
  • page (str) – (optional) The value of the opc-next-page response header from the previous paginated call.
  • sort_order (str) –

    (optional) The value of the sorting direction of resources in a paginated ‘List’ call. If unspecified, defaults to DESC.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort the results of the List query.

    Allowed values are: “id”, “domain”, “target”, “displayName”

  • id (list[str]) – (optional) Filter redirects using a list of redirect OCIDs.
  • display_name (list[str]) – (optional) Filter redirects using a display name.
  • lifecycle_state (list[str]) –

    (optional) Filter redirects using a list of lifecycle states.

    Allowed values are: “CREATING”, “ACTIVE”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”

  • time_created_greater_than_or_equal_to (datetime) – (optional) A filter that matches redirects created on or after the specified date and time.
  • time_created_less_than (datetime) – (optional) A filter that matches redirects created before the specified date-time. Default to 1 day before now.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of HttpRedirectSummary

Return type:

Response

update_http_redirect(http_redirect_id, update_http_redirect_details, **kwargs)

Updates the details of a HTTP Redirect, including target and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.

Parameters:
  • http_redirect_id (str) –

    (required) The OCID of the HTTP Redirect.

  • update_http_redirect_details (UpdateHttpRedirectDetails) – (required) The details of the HTTP Redirect to update.
  • opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations Example: If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag provided matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response