diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a67aea732e..22e0c41934 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,26 @@ All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +1.3.20 - 2018-05-03 +==================== + +Added +----- +* Support for returning names for events in the Audit service +* Support for multiple hostnames per listener in the Load Balancing service +* Helper function for Base64-ing scripts for user_data in launch instance options + + * An example of Base64-ing scripts for user_data can be found on `GitHub `__. + +Changed +------- +* Add httpsig_cffi as a vendored package + +Fixed +----- +* Multipart object put resume to account when final part is less than part size + ==================== 1.3.19 - 2018-04-19 ==================== diff --git a/Thirdpartyreadme.txt b/Thirdpartyreadme.txt new file mode 100644 index 0000000000..8846739db5 --- /dev/null +++ b/Thirdpartyreadme.txt @@ -0,0 +1,10 @@ +httpsig_cffi +============= +Copyright (c) 2014 Adam Knight +Copyright (c) 2012 Adam T. Lindsay (original author) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/docs/api/load_balancer.rst b/docs/api/load_balancer.rst index 79513e3e3d..34d1ebf0b2 100644 --- a/docs/api/load_balancer.rst +++ b/docs/api/load_balancer.rst @@ -30,12 +30,15 @@ Load Balancer oci.load_balancer.models.CreateBackendDetails oci.load_balancer.models.CreateBackendSetDetails oci.load_balancer.models.CreateCertificateDetails + oci.load_balancer.models.CreateHostnameDetails oci.load_balancer.models.CreateListenerDetails oci.load_balancer.models.CreateLoadBalancerDetails oci.load_balancer.models.CreatePathRouteSetDetails oci.load_balancer.models.HealthCheckResult oci.load_balancer.models.HealthChecker oci.load_balancer.models.HealthCheckerDetails + oci.load_balancer.models.Hostname + oci.load_balancer.models.HostnameDetails oci.load_balancer.models.IpAddress oci.load_balancer.models.Listener oci.load_balancer.models.ListenerDetails @@ -55,6 +58,7 @@ Load Balancer oci.load_balancer.models.UpdateBackendDetails oci.load_balancer.models.UpdateBackendSetDetails oci.load_balancer.models.UpdateHealthCheckerDetails + oci.load_balancer.models.UpdateHostnameDetails oci.load_balancer.models.UpdateListenerDetails oci.load_balancer.models.UpdateLoadBalancerDetails oci.load_balancer.models.UpdatePathRouteSetDetails diff --git a/docs/api/load_balancer/models/oci.load_balancer.models.CreateHostnameDetails.rst b/docs/api/load_balancer/models/oci.load_balancer.models.CreateHostnameDetails.rst new file mode 100644 index 0000000000..c6bdb6b0c6 --- /dev/null +++ b/docs/api/load_balancer/models/oci.load_balancer.models.CreateHostnameDetails.rst @@ -0,0 +1,11 @@ +CreateHostnameDetails +===================== + +.. currentmodule:: oci.load_balancer.models + +.. autoclass:: CreateHostnameDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/load_balancer/models/oci.load_balancer.models.Hostname.rst b/docs/api/load_balancer/models/oci.load_balancer.models.Hostname.rst new file mode 100644 index 0000000000..7886074b8c --- /dev/null +++ b/docs/api/load_balancer/models/oci.load_balancer.models.Hostname.rst @@ -0,0 +1,11 @@ +Hostname +======== + +.. currentmodule:: oci.load_balancer.models + +.. autoclass:: Hostname + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/load_balancer/models/oci.load_balancer.models.HostnameDetails.rst b/docs/api/load_balancer/models/oci.load_balancer.models.HostnameDetails.rst new file mode 100644 index 0000000000..022e9971e6 --- /dev/null +++ b/docs/api/load_balancer/models/oci.load_balancer.models.HostnameDetails.rst @@ -0,0 +1,11 @@ +HostnameDetails +=============== + +.. currentmodule:: oci.load_balancer.models + +.. autoclass:: HostnameDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/load_balancer/models/oci.load_balancer.models.UpdateHostnameDetails.rst b/docs/api/load_balancer/models/oci.load_balancer.models.UpdateHostnameDetails.rst new file mode 100644 index 0000000000..fc6e621c7b --- /dev/null +++ b/docs/api/load_balancer/models/oci.load_balancer.models.UpdateHostnameDetails.rst @@ -0,0 +1,11 @@ +UpdateHostnameDetails +===================== + +.. currentmodule:: oci.load_balancer.models + +.. autoclass:: UpdateHostnameDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/utilities.rst b/docs/api/utilities.rst index 53348f266c..5206aa0548 100644 --- a/docs/api/utilities.rst +++ b/docs/api/utilities.rst @@ -6,4 +6,6 @@ .. autofunction:: to_dict +.. autofunction:: file_content_as_launch_instance_user_data + .. autoclass:: Sentinel diff --git a/docs/installation.rst b/docs/installation.rst index 806e2805c1..befc25a9cd 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -51,13 +51,34 @@ The Python SDK supports operations for the following services: You can install the Python SDK through the Python Package Index (PyPI), or alternatively through GitHub. -**PyPi** +Set up a virtual environment +----------------------------- + +Oracle recommends that you run the SDK in a virtual environment with virtualenv. This allows +you to isolate the dependencies for the SDK and avoids any potential conflicts with other Python packages +which may already be installed (e.g. in your system-wide Python). + +With Linux, virtualenv is usually in a separate package from the main Python package. +If you need to install virtualenv, use ``pip install virtualenv``. +To create and activate a virtual environment:: + + virtualenv + source /bin/activate + +For example:: + + virtualenv oci_sdk_env + source oci_sdk_env/bin/activate + +PyPi +----- To install from `PyPI `_ use the following command:: pip install oci -**GitHub** +GitHub +------- To install from GitHub: @@ -74,23 +95,6 @@ To install from GitHub: Use ``pip install -U pip`` and then try to install the whl file again. -**Virtual environment (Optional)** - -Although optional, Oracle recommends that you run the SDK in a virtual environment with virtualenv. - -With Linux, it's usually in a separate package from the main Python package. -If you need to install virtualenv, use pip install virtualenv. -To create and activate a virtual environment:: - - virtualenv - source /bin/activate - -For example:: - - virtualenv oci_sdk_env - source oci_sdk_env/bin/activate - - ===================== Configuring the SDK ===================== diff --git a/examples/launch_instance/user_data.sh b/examples/launch_instance/user_data.sh new file mode 100644 index 0000000000..4f99391b97 --- /dev/null +++ b/examples/launch_instance/user_data.sh @@ -0,0 +1,8 @@ +#!/bin/bash + +# This file will be Base64-ed and provided as user_data when launching an instance. +# See: https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/datatypes/LaunchInstanceDetails +# for more information + +mkdir /tmp/mydir +touch /tmp/mydir/mytxt.txt \ No newline at end of file diff --git a/examples/launch_instance_example.py b/examples/launch_instance_example.py index bd0d904d41..7fecde6df7 100644 --- a/examples/launch_instance_example.py +++ b/examples/launch_instance_example.py @@ -247,6 +247,17 @@ def get_image(compute, operating_system, operating_system_version, shape): 'some_metadata_item': 'some item value' } + # We can also provide a user_data key in the metadata that will be used by Cloud-Init + # to run custom scripts or provide custom Cloud-Init configuration. The contents of this + # key should be Base64-encoded data and the SDK offers a convenience function to transform + # a file at a given path to that encoded data + # + # See: https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/datatypes/LaunchInstanceDetails + # for more information + instance_metadata['user_data'] = oci.util.file_content_as_launch_instance_user_data( + 'examples/launch_instance/user_data.sh' + ) + # Extended metadata differs from normal metadata in that it can support nested maps/dicts. If you are providing # these, you should consider whether defined and freeform tags on an instance would better meet your use case. instance_extended_metadata = { diff --git a/requirements.txt b/requirements.txt index 8cecb6db27..c11ac76f1c 100755 --- a/requirements.txt +++ b/requirements.txt @@ -3,7 +3,6 @@ configparser==3.5.0 coverage==4.4.1 cryptography==2.1.3 flake8==3.5.0 -httpsig_cffi==15.0.0 mock==2.0.0 PyJWT==1.5.3 pyOpenSSL==17.4.0 diff --git a/setup.py b/setup.py index fd3cdcb0d2..ad7b4a3a57 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,6 @@ def open_relative(*path): "certifi", "configparser==3.5.0", "cryptography==2.1.3", - "httpsig_cffi==15.0.0", "PyJWT==1.5.3", "pyOpenSSL<=17.4.0", "python-dateutil==2.5.3", diff --git a/src/oci/_vendor/__init__.py b/src/oci/_vendor/__init__.py new file mode 100644 index 0000000000..e36649bf84 --- /dev/null +++ b/src/oci/_vendor/__init__.py @@ -0,0 +1,4 @@ +# coding: utf-8 +# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. + +from . import httpsig_cffi # noqa: F401 diff --git a/src/oci/_vendor/httpsig_cffi/__init__.py b/src/oci/_vendor/httpsig_cffi/__init__.py new file mode 100644 index 0000000000..4f4c35e06c --- /dev/null +++ b/src/oci/_vendor/httpsig_cffi/__init__.py @@ -0,0 +1,7 @@ +# coding: utf-8 +# Modified Work: Copyright (c) 2018, 2018, Oracle and/or its affiliates. All rights reserved. +# Original Work: Copyright (c) 2014 Adam Knight +# Original Work: Copyright (c) 2012 Adam T. Lindsay (original author) + +from .sign import Signer, HeaderSigner # noqa: F401 +from .verify import Verifier, HeaderVerifier # noqa: F401 diff --git a/src/oci/_vendor/httpsig_cffi/requests_auth.py b/src/oci/_vendor/httpsig_cffi/requests_auth.py new file mode 100644 index 0000000000..1edd3ec73c --- /dev/null +++ b/src/oci/_vendor/httpsig_cffi/requests_auth.py @@ -0,0 +1,47 @@ +# coding: utf-8 +# Modified Work: Copyright (c) 2018, 2018, Oracle and/or its affiliates. All rights reserved. +# Original Work: Copyright (c) 2014 Adam Knight +# Original Work: Copyright (c) 2012 Adam T. Lindsay (original author) + +from requests.auth import AuthBase +try: + # Python 3 + from urllib.parse import urlparse +except ImportError: + # Python 2 + from urlparse import urlparse + +from .sign import HeaderSigner + + +class HTTPSignatureAuth(AuthBase): + ''' + Sign a request using the http-signature scheme. + https://github.com/joyent/node-http-signature/blob/master/http_signing.md + + key_id is the mandatory label indicating to the server which secret to use + secret is the filename of a pem file in the case of rsa, a password string in the case of an hmac algorithm + algorithm is one of the six specified algorithms + headers is a list of http headers to be included in the signing string, defaulting to "Date" alone. + ''' + def __init__(self, key_id='', secret='', algorithm=None, headers=None): + headers = headers or [] + self.header_signer = HeaderSigner( + key_id=key_id, + secret=secret, + algorithm=algorithm, + headers=headers + ) + self.uses_host = 'host' in [h.lower() for h in headers] + + def __call__(self, r): + headers = self.header_signer.sign( + r.headers, + # 'Host' header unavailable in request object at this point + # if 'host' header is needed, extract it from the url + host=urlparse(r.url).netloc if self.uses_host else None, + method=r.method, + path=r.path_url + ) + r.headers.update(headers) + return r diff --git a/src/oci/_vendor/httpsig_cffi/sign.py b/src/oci/_vendor/httpsig_cffi/sign.py new file mode 100644 index 0000000000..5bab7f87d5 --- /dev/null +++ b/src/oci/_vendor/httpsig_cffi/sign.py @@ -0,0 +1,127 @@ +# coding: utf-8 +# Modified Work: Copyright (c) 2018, 2018, Oracle and/or its affiliates. All rights reserved. +# Original Work: Copyright (c) 2014 Adam Knight +# Original Work: Copyright (c) 2012 Adam T. Lindsay (original author) + +import base64 +import six + +from cryptography.hazmat.backends import default_backend # noqa: F401 +from cryptography.hazmat.primitives import hashes, hmac, serialization # noqa: F401 +from cryptography.hazmat.primitives.asymmetric import rsa, padding # noqa: F401 + +from .utils import * # noqa: F403 + + +DEFAULT_SIGN_ALGORITHM = "hmac-sha256" + + +class Signer(object): + """ + When using an RSA algo, the secret is a PEM-encoded private or public key. + When using an HMAC algo, the secret is the HMAC signing secret. + + Password-protected keyfiles are not supported. + """ + def __init__(self, secret, algorithm=None): + if algorithm is None: + algorithm = DEFAULT_SIGN_ALGORITHM + + assert algorithm in ALGORITHMS, "Unknown algorithm" # noqa: F405 + if isinstance(secret, six.string_types): + secret = secret.encode("ascii") + + self._rsa_public = None + self._rsa_private = None + self._hash = None + self.sign_algorithm, self.hash_algorithm = algorithm.split('-') + + if self.sign_algorithm == 'rsa': + try: + self._rsahash = HASHES[self.hash_algorithm] # noqa: 405 + self._rsa_private = serialization.load_pem_private_key( + secret, + None, + backend=default_backend() + ) + self._rsa_public = self._rsa_private.public_key() + except ValueError as e: # noqa: F841 + try: + self._rsa_public = serialization.load_pem_public_key( + secret, + backend=default_backend() + ) + except ValueError as e: # noqa: F841 + raise HttpSigException("Invalid key.") # noqa: 405 + elif self.sign_algorithm == 'hmac': + self._hash = hmac.HMAC( + secret, + HASHES[self.hash_algorithm](), # noqa: 405 + backend=default_backend() + ) + + @property + def algorithm(self): + return '%s-%s' % (self.sign_algorithm, self.hash_algorithm) + + def _sign_rsa(self, data): + if isinstance(data, six.string_types): + data = data.encode("ascii") + return self._rsa_private.sign(data, padding.PKCS1v15(), self._rsahash()) + + def _sign_hmac(self, data): + if isinstance(data, six.string_types): + data = data.encode("ascii") + hmac = self._hash.copy() + hmac.update(data) + return hmac.finalize() + + def _sign(self, data): + if isinstance(data, six.string_types): + data = data.encode("ascii") + + signed = None + if self._rsa_private: + signed = self._sign_rsa(data) + elif self._hash: + signed = self._sign_hmac(data) + if not signed: + raise SystemError('No valid encryptor found.') + return base64.b64encode(signed).decode("ascii") + + +class HeaderSigner(Signer): + ''' + Generic object that will sign headers as a dictionary using the http-signature scheme. + https://github.com/joyent/node-http-signature/blob/master/http_signing.md + + :arg key_id: the mandatory label indicating to the server which secret to use + :arg secret: a PEM-encoded RSA private key or an HMAC secret (must match the algorithm) + :arg algorithm: one of the six specified algorithms + :arg headers: a list of http headers to be included in the signing string, defaulting to ['date']. + ''' + def __init__(self, key_id, secret, algorithm=None, headers=None): + if algorithm is None: + algorithm = DEFAULT_SIGN_ALGORITHM + + super(HeaderSigner, self).__init__(secret=secret, algorithm=algorithm) + self.headers = headers or ['date'] + self.signature_template = build_signature_template(key_id, algorithm, headers) # noqa: 405 + + def sign(self, headers, host=None, method=None, path=None): + """ + Add Signature Authorization header to case-insensitive header dict. + + headers is a case-insensitive dict of mutable headers. + host is a override for the 'host' header (defaults to value in headers). + method is the HTTP method (required when using '(request-target)'). + path is the HTTP path (required when using '(request-target)'). + """ + headers = CaseInsensitiveDict(headers) # noqa: 405 + required_headers = self.headers or ['date'] + signable = generate_message(required_headers, headers, host, method, path) # noqa: 405 + + signature = self._sign(signable) + headers['authorization'] = self.signature_template % signature + + return headers diff --git a/src/oci/_vendor/httpsig_cffi/utils.py b/src/oci/_vendor/httpsig_cffi/utils.py new file mode 100644 index 0000000000..d525848d51 --- /dev/null +++ b/src/oci/_vendor/httpsig_cffi/utils.py @@ -0,0 +1,171 @@ +# coding: utf-8 +# Modified Work: Copyright (c) 2018, 2018, Oracle and/or its affiliates. All rights reserved. +# Original Work: Copyright (c) 2014 Adam Knight +# Original Work: Copyright (c) 2012 Adam T. Lindsay (original author) + +import re +import struct +import hashlib +import base64 +import six + +try: + # Python 3 + from urllib.request import parse_http_list +except ImportError: + # Python 2 + from urllib2 import parse_http_list + +from cryptography.hazmat.primitives.hashes import SHA1, SHA256, SHA512 + +ALGORITHMS = frozenset(['rsa-sha1', 'rsa-sha256', 'rsa-sha512', 'hmac-sha1', 'hmac-sha256', 'hmac-sha512']) +HASHES = {'sha1': SHA1, 'sha256': SHA256, 'sha512': SHA512} + + +class HttpSigException(Exception): + pass + + +def generate_message(required_headers, headers, host=None, method=None, path=None): + headers = CaseInsensitiveDict(headers) + + if not required_headers: + required_headers = ['date'] + + signable_list = [] + for h in required_headers: + h = h.lower() + if h == '(request-target)': + if not method or not path: + raise Exception('method and path arguments required when using "(request-target)"') + signable_list.append('%s: %s %s' % (h, method.lower(), path)) + + elif h == 'host': + # 'host' special case due to requests lib restrictions + # 'host' is not available when adding auth so must use a param + # if no param used, defaults back to the 'host' header + if not host: + if 'host' in headers: + host = headers[h] + else: + raise Exception('missing required header "%s"' % (h)) + signable_list.append('%s: %s' % (h, host)) + else: + if h not in headers: + raise Exception('missing required header "%s"' % (h)) + + signable_list.append('%s: %s' % (h, headers[h])) + + signable = '\n'.join(signable_list).encode("ascii") + return signable + + +def parse_authorization_header(header): + if not isinstance(header, six.string_types): + header = header.decode("ascii") # HTTP headers cannot be Unicode. + + auth = header.split(" ", 1) + if len(auth) > 2: + raise ValueError('Invalid authorization header. (eg. Method key1=value1,key2="value, \"2\"")') + + # Split up any args into a dictionary. + values = {} + if len(auth) == 2: + auth_value = auth[1] + if auth_value and len(auth_value): + # This is tricky string magic. Let urllib do it. + fields = parse_http_list(auth_value) + + for item in fields: + # Only include keypairs. + if '=' in item: + # Split on the first '=' only. + key, value = item.split('=', 1) + if not (len(key) and len(value)): + continue + + # Unquote values, if quoted. + if value[0] == '"': + value = value[1:-1] + + values[key] = value + + # ("Signature", {"headers": "date", "algorithm": "hmac-sha256", ... }) + return (auth[0], CaseInsensitiveDict(values)) + + +def build_signature_template(key_id, algorithm, headers): + """ + Build the Signature template for use with the Authorization header. + + key_id is the mandatory label indicating to the server which secret to use + algorithm is one of the six specified algorithms + headers is a list of http headers to be included in the signing string. + + The signature must be interpolated into the template to get the final Authorization header value. + """ + param_map = {'keyId': key_id, + 'algorithm': algorithm, + 'signature': '%s'} + if headers: + headers = [h.lower() for h in headers] + param_map['headers'] = ' '.join(headers) + kv = map('{0[0]}="{0[1]}"'.format, param_map.items()) + kv_string = ','.join(kv) + sig_string = 'Signature {0}'.format(kv_string) + return sig_string + + +def lkv(d): + parts = [] + while d: + len = struct.unpack('>I', d[:4])[0] + bits = d[4:(len + 4)] + parts.append(bits) + d = d[(len + 4):] + return parts + + +def sig(d): + return lkv(d)[1] + + +def is_rsa(keyobj): + return lkv(keyobj.blob)[0] == "ssh-rsa" + + +# based on http://stackoverflow.com/a/2082169/151401 +class CaseInsensitiveDict(dict): + def __init__(self, d=None, **kwargs): + super(CaseInsensitiveDict, self).__init__(**kwargs) + if d: + self.update((k.lower(), v) for k, v in six.iteritems(d)) + + def __setitem__(self, key, value): + super(CaseInsensitiveDict, self).__setitem__(key.lower(), value) + + def __getitem__(self, key): + return super(CaseInsensitiveDict, self).__getitem__(key.lower()) + + def __contains__(self, key): + return super(CaseInsensitiveDict, self).__contains__(key.lower()) + + +# currently busted... +def get_fingerprint(key): + """ + Takes an ssh public key and generates the fingerprint. + + See: http://tools.ietf.org/html/rfc4716 for more info + """ + if key.startswith('ssh-rsa'): + key = key.split(' ')[1] + else: + regex = r'\-{4,5}[\w|| ]+\-{4,5}' + key = re.split(regex, key)[1] + + key = key.replace('\n', '') + key = key.strip().encode('ascii') + key = base64.b64decode(key) + fp_plain = hashlib.md5(key).hexdigest() + return ':'.join(a + b for a, b in zip(fp_plain[::2], fp_plain[1::2])) diff --git a/src/oci/_vendor/httpsig_cffi/verify.py b/src/oci/_vendor/httpsig_cffi/verify.py new file mode 100644 index 0000000000..de026c1fc5 --- /dev/null +++ b/src/oci/_vendor/httpsig_cffi/verify.py @@ -0,0 +1,104 @@ +# coding: utf-8 +# Modified Work: Copyright (c) 2018, 2018, Oracle and/or its affiliates. All rights reserved. +# Original Work: Copyright (c) 2014 Adam Knight +# Original Work: Copyright (c) 2012 Adam T. Lindsay (original author) + +""" +Module to assist in verifying a signed header. +""" +import six + +from cryptography.hazmat.backends import default_backend # noqa: 401 +from cryptography.hazmat.primitives import hashes, hmac, serialization # noqa: 401 +from cryptography.hazmat.primitives.asymmetric import rsa, padding # noqa: 401 +from cryptography.exceptions import InvalidSignature # noqa: 401 + +from base64 import b64decode + +from .sign import Signer +from .utils import * # noqa: 403 + + +class Verifier(Signer): + """ + Verifies signed text against a secret. + For HMAC, the secret is the shared secret. + For RSA, the secret is the PUBLIC key. + """ + def _verify(self, data, signature): + """ + Verifies the data matches a signed version with the given signature. + `data` is the message to verify + `signature` is a base64-encoded signature to verify against `data` + """ + + if isinstance(data, six.string_types): + data = data.encode("ascii") + if isinstance(signature, six.string_types): + signature = signature.encode("ascii") + + if self.sign_algorithm == 'rsa': + try: + self._rsa_public.verify( + b64decode(signature), + data, + padding.PKCS1v15(), + self._rsahash() + ) + return True + except InvalidSignature: + return False + elif self.sign_algorithm == 'hmac': + h = self._sign_hmac(data) + s = b64decode(signature) + return (h == s) + else: + raise HttpSigException("Unsupported algorithm.") # noqa: 405 + + +class HeaderVerifier(Verifier): + """ + Verifies an HTTP signature from given headers. + """ + def __init__(self, headers, secret, required_headers=None, method=None, path=None, host=None): + """ + Instantiate a HeaderVerifier object. + + :param headers: A dictionary of headers from the HTTP request. + :param secret: The HMAC secret or RSA *public* key. + :param required_headers: Optional. A list of headers required to be present to validate, even if the signature is otherwise valid. Defaults to ['date']. + :param method: Optional. The HTTP method used in the request (eg. "GET"). Required for the '(request-target)' header. + :param path: Optional. The HTTP path requested, exactly as sent (including query arguments and fragments). Required for the '(request-target)' header. + :param host: Optional. The value to use for the Host header, if not supplied in :param:headers. + """ + required_headers = required_headers or ['date'] + + auth = parse_authorization_header(headers['authorization']) # noqa: 405 + if len(auth) == 2: + self.auth_dict = auth[1] + else: + raise HttpSigException("Invalid authorization header.") # noqa: 405 + + self.headers = CaseInsensitiveDict(headers) # noqa: 405 + self.required_headers = [s.lower() for s in required_headers] + self.method = method + self.path = path + self.host = host + + super(HeaderVerifier, self).__init__(secret, algorithm=self.auth_dict['algorithm']) + + def verify(self): + """ + Verify the headers based on the arguments passed at creation and current properties. + + Raises an Exception if a required header (:param:required_headers) is not found in the signature. + Returns True or False. + """ + auth_headers = self.auth_dict.get('headers', 'date').split(' ') + + if len(set(self.required_headers) - set(auth_headers)) > 0: + raise Exception('{} is a required header(s)'.format(', '.join(set(self.required_headers) - set(auth_headers)))) + + signing_str = generate_message(auth_headers, self.headers, self.host, self.method, self.path) # noqa: 405 + + return self._verify(signing_str, self.auth_dict['signature']) diff --git a/src/oci/audit/audit_client.py b/src/oci/audit/audit_client.py index 40cf57a6e9..675e46083d 100644 --- a/src/oci/audit/audit_client.py +++ b/src/oci/audit/audit_client.py @@ -87,6 +87,14 @@ def get_configuration(self, compartment_id, **kwargs): :param str compartment_id: (required) ID of the root compartment (tenancy) + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.audit.models.Configuration` :rtype: :class:`~oci.response.Response` """ @@ -159,6 +167,14 @@ def list_events(self, compartment_id, start_time, end_time, **kwargs): Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.audit.models.AuditEvent` :rtype: :class:`~oci.response.Response` """ @@ -223,6 +239,14 @@ def update_configuration(self, compartment_id, update_configuration_details, **k :param UpdateConfigurationDetails update_configuration_details: (required) The configuration properties + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/audit/models/audit_event.py b/src/oci/audit/models/audit_event.py index 5457f54f5a..0d9c5c1f02 100644 --- a/src/oci/audit/models/audit_event.py +++ b/src/oci/audit/models/audit_event.py @@ -29,6 +29,10 @@ def __init__(self, **kwargs): The value to assign to the event_id property of this AuditEvent. :type event_id: str + :param event_name: + The value to assign to the event_name property of this AuditEvent. + :type event_name: str + :param event_source: The value to assign to the event_source property of this AuditEvent. :type event_source: str @@ -98,6 +102,7 @@ def __init__(self, **kwargs): 'tenant_id': 'str', 'compartment_id': 'str', 'event_id': 'str', + 'event_name': 'str', 'event_source': 'str', 'event_type': 'str', 'event_time': 'datetime', @@ -120,6 +125,7 @@ def __init__(self, **kwargs): 'tenant_id': 'tenantId', 'compartment_id': 'compartmentId', 'event_id': 'eventId', + 'event_name': 'eventName', 'event_source': 'eventSource', 'event_type': 'eventType', 'event_time': 'eventTime', @@ -141,6 +147,7 @@ def __init__(self, **kwargs): self._tenant_id = None self._compartment_id = None self._event_id = None + self._event_name = None self._event_source = None self._event_type = None self._event_time = None @@ -230,6 +237,32 @@ def event_id(self, event_id): """ self._event_id = event_id + @property + def event_name(self): + """ + Gets the event_name of this AuditEvent. + The name of the event. + Example: `LaunchInstance` + + + :return: The event_name of this AuditEvent. + :rtype: str + """ + return self._event_name + + @event_name.setter + def event_name(self, event_name): + """ + Sets the event_name of this AuditEvent. + The name of the event. + Example: `LaunchInstance` + + + :param event_name: The event_name of this AuditEvent. + :type: str + """ + self._event_name = event_name + @property def event_source(self): """ diff --git a/src/oci/auth/federation_client.py b/src/oci/auth/federation_client.py index 76ad038c7a..f22d9ab469 100644 --- a/src/oci/auth/federation_client.py +++ b/src/oci/auth/federation_client.py @@ -129,7 +129,25 @@ def _get_security_token_from_auth_service(self): response = requests.post(self.federation_endpoint, json=request_payload, auth=signer, verify=self.cert_bundle_verify) else: response = requests.post(self.federation_endpoint, json=request_payload, auth=signer) - self.security_token = SecurityTokenContainer(self.session_key_supplier, response.json()['token']) + + parsed_response = None + try: + parsed_response = response.json() + except ValueError: + raise RuntimeError('Unable to parse response from auth service ({}): {}'.format(self.federation_endpoint, response.text)) + + if not response.ok: + raise oci.exceptions.ServiceError( + response.status_code, + parsed_response.get('code'), + response.headers, + parsed_response.get('message') + ) + else: + if 'token' in parsed_response: + self.security_token = SecurityTokenContainer(self.session_key_supplier, response.json()['token']) + else: + raise RuntimeError('Could not find token in response from auth service ({}): {}'.format(self.federation_endpoint, parsed_response)) class AuthTokenRequestSigner(oci.signer.AbstractBaseSigner): diff --git a/src/oci/base_client.py b/src/oci/base_client.py index b950c9e0c2..8d75ff6c64 100644 --- a/src/oci/base_client.py +++ b/src/oci/base_client.py @@ -382,7 +382,7 @@ def sanitize_for_serialization(self, obj, declared_type=None, field_name=None): if declared_type and not self.is_none_or_none_sentinel(obj): if declared_type.startswith('dict(') and not isinstance(obj, dict): self.raise_type_error_serializing_model(field_name, obj, declared_type) - elif declared_type.startswith('list[') and not isinstance(obj, list): + elif declared_type.startswith('list[') and not (isinstance(obj, list) or isinstance(obj, tuple)): self.raise_type_error_serializing_model(field_name, obj, declared_type) elif declared_type in self.complex_type_mappings: # if its supposed to be one of our models, it can either be an instance of that model OR a dict @@ -396,7 +396,7 @@ def sanitize_for_serialization(self, obj, declared_type=None, field_name=None): return obj elif obj is NONE_SENTINEL: return None - elif isinstance(obj, list): + elif isinstance(obj, list) or isinstance(obj, tuple): return [self.sanitize_for_serialization( sub_obj, self.extract_list_item_type_from_swagger_type(declared_type) if declared_type else None, diff --git a/src/oci/core/blockstorage_client.py b/src/oci/core/blockstorage_client.py index 928ad26069..68852b7744 100644 --- a/src/oci/core/blockstorage_client.py +++ b/src/oci/core/blockstorage_client.py @@ -111,6 +111,14 @@ def create_volume(self, create_volume_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Volume` :rtype: :class:`~oci.response.Response` """ @@ -179,6 +187,14 @@ def create_volume_backup(self, create_volume_backup_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeBackup` :rtype: :class:`~oci.response.Response` """ @@ -235,6 +251,14 @@ def create_volume_backup_policy_assignment(self, create_volume_backup_policy_ass :param CreateVolumeBackupPolicyAssignmentDetails create_volume_backup_policy_assignment_details: (required) Request to assign a specified policy to a particular asset. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeBackupPolicyAssignment` :rtype: :class:`~oci.response.Response` """ @@ -291,6 +315,14 @@ def delete_boot_volume(self, boot_volume_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -361,6 +393,14 @@ def delete_volume(self, volume_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -426,6 +466,14 @@ def delete_volume_backup(self, volume_backup_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -491,6 +539,14 @@ def delete_volume_backup_policy_assignment(self, policy_assignment_id, **kwargs) 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -551,6 +607,14 @@ def get_boot_volume(self, boot_volume_id, **kwargs): :param str boot_volume_id: (required) The OCID of the boot volume. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.BootVolume` :rtype: :class:`~oci.response.Response` """ @@ -607,6 +671,14 @@ def get_volume(self, volume_id, **kwargs): :param str volume_id: (required) The OCID of the volume. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Volume` :rtype: :class:`~oci.response.Response` """ @@ -663,6 +735,14 @@ def get_volume_backup(self, volume_backup_id, **kwargs): :param str volume_backup_id: (required) The OCID of the volume backup. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeBackup` :rtype: :class:`~oci.response.Response` """ @@ -719,6 +799,14 @@ def get_volume_backup_policy(self, policy_id, **kwargs): :param str policy_id: (required) The OCID of the volume backup policy. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeBackupPolicy` :rtype: :class:`~oci.response.Response` """ @@ -785,6 +873,14 @@ def get_volume_backup_policy_asset_assignment(self, asset_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VolumeBackupPolicyAssignment` :rtype: :class:`~oci.response.Response` """ @@ -843,6 +939,14 @@ def get_volume_backup_policy_assignment(self, policy_assignment_id, **kwargs): :param str policy_assignment_id: (required) The OCID of the volume backup policy assignment. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeBackupPolicyAssignment` :rtype: :class:`~oci.response.Response` """ @@ -912,6 +1016,14 @@ def list_boot_volumes(self, availability_domain, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.BootVolume` :rtype: :class:`~oci.response.Response` """ @@ -976,6 +1088,14 @@ def list_volume_backup_policies(self, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VolumeBackupPolicy` :rtype: :class:`~oci.response.Response` """ @@ -1070,6 +1190,14 @@ def list_volume_backups(self, compartment_id, **kwargs): Allowed values are: "CREATING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY", "REQUEST_RECEIVED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VolumeBackup` :rtype: :class:`~oci.response.Response` """ @@ -1198,6 +1326,14 @@ def list_volumes(self, compartment_id, **kwargs): Allowed values are: "PROVISIONING", "RESTORING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Volume` :rtype: :class:`~oci.response.Response` """ @@ -1295,6 +1431,14 @@ def update_boot_volume(self, boot_volume_id, update_boot_volume_details, **kwarg 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.BootVolume` :rtype: :class:`~oci.response.Response` """ @@ -1368,6 +1512,14 @@ def update_volume(self, volume_id, update_volume_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Volume` :rtype: :class:`~oci.response.Response` """ @@ -1441,6 +1593,14 @@ def update_volume_backup(self, volume_backup_id, update_volume_backup_details, * 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeBackup` :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/core/compute_client.py b/src/oci/core/compute_client.py index c1e821873a..b868516992 100644 --- a/src/oci/core/compute_client.py +++ b/src/oci/core/compute_client.py @@ -94,6 +94,14 @@ def attach_boot_volume(self, attach_boot_volume_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.BootVolumeAttachment` :rtype: :class:`~oci.response.Response` """ @@ -159,6 +167,14 @@ def attach_vnic(self, attach_vnic_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VnicAttachment` :rtype: :class:`~oci.response.Response` """ @@ -220,6 +236,14 @@ def attach_volume(self, attach_volume_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeAttachment` :rtype: :class:`~oci.response.Response` """ @@ -297,6 +321,14 @@ def capture_console_history(self, capture_console_history_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.ConsoleHistory` :rtype: :class:`~oci.response.Response` """ @@ -385,6 +417,14 @@ def create_image(self, create_image_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Image` :rtype: :class:`~oci.response.Response` """ @@ -452,6 +492,14 @@ def create_instance_console_connection(self, create_instance_console_connection_ has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InstanceConsoleConnection` :rtype: :class:`~oci.response.Response` """ @@ -511,6 +559,14 @@ def delete_console_history(self, instance_console_history_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -576,6 +632,14 @@ def delete_image(self, image_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -641,6 +705,14 @@ def delete_instance_console_connection(self, instance_console_connection_id, **k 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -709,6 +781,14 @@ def detach_boot_volume(self, boot_volume_attachment_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -785,6 +865,14 @@ def detach_vnic(self, vnic_attachment_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -853,6 +941,14 @@ def detach_volume(self, volume_attachment_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -942,6 +1038,14 @@ def export_image(self, image_id, export_image_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Image` :rtype: :class:`~oci.response.Response` """ @@ -1010,6 +1114,14 @@ def get_boot_volume_attachment(self, boot_volume_attachment_id, **kwargs): :param str boot_volume_attachment_id: (required) The OCID of the boot volume attachment. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.BootVolumeAttachment` :rtype: :class:`~oci.response.Response` """ @@ -1068,6 +1180,14 @@ def get_console_history(self, instance_console_history_id, **kwargs): :param str instance_console_history_id: (required) The OCID of the console history. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.ConsoleHistory` :rtype: :class:`~oci.response.Response` """ @@ -1132,6 +1252,14 @@ def get_console_history_content(self, instance_console_history_id, **kwargs): :param int length: (optional) Length of the snapshot data to retrieve. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type bytes :rtype: :class:`~oci.response.Response` """ @@ -1201,6 +1329,14 @@ def get_image(self, image_id, **kwargs): :param str image_id: (required) The OCID of the image. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Image` :rtype: :class:`~oci.response.Response` """ @@ -1257,6 +1393,14 @@ def get_instance(self, instance_id, **kwargs): :param str instance_id: (required) The OCID of the instance. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Instance` :rtype: :class:`~oci.response.Response` """ @@ -1313,6 +1457,14 @@ def get_instance_console_connection(self, instance_console_connection_id, **kwar :param str instance_console_connection_id: (required) The OCID of the intance console connection + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InstanceConsoleConnection` :rtype: :class:`~oci.response.Response` """ @@ -1369,6 +1521,14 @@ def get_vnic_attachment(self, vnic_attachment_id, **kwargs): :param str vnic_attachment_id: (required) The OCID of the VNIC attachment. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VnicAttachment` :rtype: :class:`~oci.response.Response` """ @@ -1425,6 +1585,14 @@ def get_volume_attachment(self, volume_attachment_id, **kwargs): :param str volume_attachment_id: (required) The OCID of the volume attachment. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeAttachment` :rtype: :class:`~oci.response.Response` """ @@ -1475,13 +1643,21 @@ def get_volume_attachment(self, volume_attachment_id, **kwargs): def get_windows_instance_initial_credentials(self, instance_id, **kwargs): """ GetWindowsInstanceInitialCredentials - Gets the generated credentials for the instance. Only works for Windows instances. The returned credentials - are only valid for the initial login. + Gets the generated credentials for the instance. Only works for instances that require password to log in (E.g. Windows). + For certain OS'es, users will be forced to change the initial credentials. :param str instance_id: (required) The OCID of the instance. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InstanceCredentials` :rtype: :class:`~oci.response.Response` """ @@ -1570,6 +1746,14 @@ def instance_action(self, instance_id, action, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Instance` :rtype: :class:`~oci.response.Response` """ @@ -1685,6 +1869,14 @@ def launch_instance(self, launch_instance_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Instance` :rtype: :class:`~oci.response.Response` """ @@ -1759,6 +1951,14 @@ def list_boot_volume_attachments(self, availability_domain, compartment_id, **kw :param str boot_volume_id: (optional) The OCID of the boot volume. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.BootVolumeAttachment` :rtype: :class:`~oci.response.Response` """ @@ -1861,6 +2061,14 @@ def list_console_histories(self, compartment_id, **kwargs): Allowed values are: "REQUESTED", "GETTING-HISTORY", "SUCCEEDED", "FAILED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.ConsoleHistory` :rtype: :class:`~oci.response.Response` """ @@ -2003,6 +2211,14 @@ def list_images(self, compartment_id, **kwargs): Allowed values are: "PROVISIONING", "IMPORTING", "AVAILABLE", "EXPORTING", "DISABLED", "DELETED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Image` :rtype: :class:`~oci.response.Response` """ @@ -2092,7 +2308,7 @@ def list_instance_console_connections(self, compartment_id, **kwargs): ListInstanceConsoleConnections Lists the console connections for the specified compartment or instance. - For more information about console access, see `Accessing the Instance Console`__. + For more information about console access, see `Accessing the Console`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/serialconsole.htm @@ -2111,6 +2327,14 @@ def list_instance_console_connections(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.InstanceConsoleConnection` :rtype: :class:`~oci.response.Response` """ @@ -2212,6 +2436,14 @@ def list_instances(self, compartment_id, **kwargs): Allowed values are: "PROVISIONING", "RUNNING", "STARTING", "STOPPING", "STOPPED", "CREATING_IMAGE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Instance` :rtype: :class:`~oci.response.Response` """ @@ -2318,6 +2550,14 @@ def list_shapes(self, compartment_id, **kwargs): :param str image_id: (optional) The OCID of an image. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Shape` :rtype: :class:`~oci.response.Response` """ @@ -2401,6 +2641,14 @@ def list_vnic_attachments(self, compartment_id, **kwargs): :param str vnic_id: (optional) The OCID of the VNIC. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VnicAttachment` :rtype: :class:`~oci.response.Response` """ @@ -2488,6 +2736,14 @@ def list_volume_attachments(self, compartment_id, **kwargs): :param str volume_id: (optional) The OCID of the volume. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VolumeAttachment` :rtype: :class:`~oci.response.Response` """ @@ -2568,6 +2824,14 @@ def terminate_instance(self, instance_id, **kwargs): Specifies whether to delete or preserve the boot volume when terminating an instance. The default value is false. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2644,6 +2908,14 @@ def update_console_history(self, instance_console_history_id, update_console_his 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.ConsoleHistory` :rtype: :class:`~oci.response.Response` """ @@ -2723,6 +2995,14 @@ def update_image(self, image_id, update_image_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Image` :rtype: :class:`~oci.response.Response` """ @@ -2807,6 +3087,14 @@ def update_instance(self, instance_id, update_instance_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Instance` :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/core/models/boot_volume.py b/src/oci/core/models/boot_volume.py index f6887bafb7..6b9dc9b81e 100644 --- a/src/oci/core/models/boot_volume.py +++ b/src/oci/core/models/boot_volume.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class BootVolume(object): """ - A detachable boot volume device that contains the image used to boot an Compute instance. For more information, see + A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see `Overview of Boot Volumes`__. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, diff --git a/src/oci/core/virtual_network_client.py b/src/oci/core/virtual_network_client.py index addcfc8ea7..4389c398b8 100644 --- a/src/oci/core/virtual_network_client.py +++ b/src/oci/core/virtual_network_client.py @@ -93,6 +93,14 @@ def bulk_add_virtual_circuit_public_prefixes(self, virtual_circuit_id, bulk_add_ :param BulkAddVirtualCircuitPublicPrefixesDetails bulk_add_virtual_circuit_public_prefixes_details: (required) Request with publix prefixes to be added to the virtual circuit + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -155,6 +163,14 @@ def bulk_delete_virtual_circuit_public_prefixes(self, virtual_circuit_id, bulk_d :param BulkDeleteVirtualCircuitPublicPrefixesDetails bulk_delete_virtual_circuit_public_prefixes_details: (required) Request with publix prefixes to be deleted from the virtual circuit + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -223,6 +239,14 @@ def connect_local_peering_gateways(self, local_peering_gateway_id, connect_local :param ConnectLocalPeeringGatewaysDetails connect_local_peering_gateways_details: (required) Details regarding the local peering gateway to connect. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -291,6 +315,14 @@ def connect_remote_peering_connections(self, remote_peering_connection_id, conne :param ConnectRemotePeeringConnectionsDetails connect_remote_peering_connections_details: (required) Details to connect peering connection with peering connection from remote region + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -373,6 +405,14 @@ def create_cpe(self, create_cpe_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Cpe` :rtype: :class:`~oci.response.Response` """ @@ -456,6 +496,14 @@ def create_cross_connect(self, create_cross_connect_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnect` :rtype: :class:`~oci.response.Response` """ @@ -535,6 +583,14 @@ def create_cross_connect_group(self, create_cross_connect_group_details, **kwarg has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnectGroup` :rtype: :class:`~oci.response.Response` """ @@ -610,6 +666,14 @@ def create_dhcp_options(self, create_dhcp_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DhcpOptions` :rtype: :class:`~oci.response.Response` """ @@ -686,6 +750,14 @@ def create_drg(self, create_drg_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Drg` :rtype: :class:`~oci.response.Response` """ @@ -760,6 +832,14 @@ def create_drg_attachment(self, create_drg_attachment_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DrgAttachment` :rtype: :class:`~oci.response.Response` """ @@ -845,6 +925,14 @@ def create_internet_gateway(self, create_internet_gateway_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InternetGateway` :rtype: :class:`~oci.response.Response` """ @@ -936,6 +1024,14 @@ def create_ip_sec_connection(self, create_ip_sec_connection_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnection` :rtype: :class:`~oci.response.Response` """ @@ -997,6 +1093,14 @@ def create_local_peering_gateway(self, create_local_peering_gateway_details, **k has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.LocalPeeringGateway` :rtype: :class:`~oci.response.Response` """ @@ -1062,6 +1166,14 @@ def create_private_ip(self, create_private_ip_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PrivateIp` :rtype: :class:`~oci.response.Response` """ @@ -1144,6 +1256,14 @@ def create_public_ip(self, create_public_ip_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PublicIp` :rtype: :class:`~oci.response.Response` """ @@ -1205,6 +1325,14 @@ def create_remote_peering_connection(self, create_remote_peering_connection_deta has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.RemotePeeringConnection` :rtype: :class:`~oci.response.Response` """ @@ -1285,6 +1413,14 @@ def create_route_table(self, create_route_table_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.RouteTable` :rtype: :class:`~oci.response.Response` """ @@ -1364,6 +1500,14 @@ def create_security_list(self, create_security_list_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.SecurityList` :rtype: :class:`~oci.response.Response` """ @@ -1464,6 +1608,14 @@ def create_subnet(self, create_subnet_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Subnet` :rtype: :class:`~oci.response.Response` """ @@ -1560,6 +1712,14 @@ def create_vcn(self, create_vcn_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vcn` :rtype: :class:`~oci.response.Response` """ @@ -1646,6 +1806,14 @@ def create_virtual_circuit(self, create_virtual_circuit_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VirtualCircuit` :rtype: :class:`~oci.response.Response` """ @@ -1707,6 +1875,14 @@ def delete_cpe(self, cpe_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1773,6 +1949,14 @@ def delete_cross_connect(self, cross_connect_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1840,6 +2024,14 @@ def delete_cross_connect_group(self, cross_connect_group_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1909,6 +2101,14 @@ def delete_dhcp_options(self, dhcp_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1977,6 +2177,14 @@ def delete_drg(self, drg_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2044,6 +2252,14 @@ def delete_drg_attachment(self, drg_attachment_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2113,6 +2329,14 @@ def delete_internet_gateway(self, ig_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2185,6 +2409,14 @@ def delete_ip_sec_connection(self, ipsc_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2253,6 +2485,14 @@ def delete_local_peering_gateway(self, local_peering_gateway_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2330,6 +2570,14 @@ def delete_private_ip(self, private_ip_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2405,6 +2653,14 @@ def delete_public_ip(self, public_ip_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2473,6 +2729,14 @@ def delete_remote_peering_connection(self, remote_peering_connection_id, **kwarg 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2542,6 +2806,14 @@ def delete_route_table(self, rt_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2611,6 +2883,14 @@ def delete_security_list(self, security_list_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2678,6 +2958,14 @@ def delete_subnet(self, subnet_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2745,6 +3033,14 @@ def delete_vcn(self, vcn_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2814,6 +3110,14 @@ def delete_virtual_circuit(self, virtual_circuit_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2874,6 +3178,14 @@ def get_cpe(self, cpe_id, **kwargs): :param str cpe_id: (required) The OCID of the CPE. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Cpe` :rtype: :class:`~oci.response.Response` """ @@ -2930,6 +3242,14 @@ def get_cross_connect(self, cross_connect_id, **kwargs): :param str cross_connect_id: (required) The OCID of the cross-connect. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnect` :rtype: :class:`~oci.response.Response` """ @@ -2986,6 +3306,14 @@ def get_cross_connect_group(self, cross_connect_group_id, **kwargs): :param str cross_connect_group_id: (required) The OCID of the cross-connect group. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnectGroup` :rtype: :class:`~oci.response.Response` """ @@ -3042,6 +3370,14 @@ def get_cross_connect_letter_of_authority(self, cross_connect_id, **kwargs): :param str cross_connect_id: (required) The OCID of the cross-connect. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.LetterOfAuthority` :rtype: :class:`~oci.response.Response` """ @@ -3098,6 +3434,14 @@ def get_cross_connect_status(self, cross_connect_id, **kwargs): :param str cross_connect_id: (required) The OCID of the cross-connect. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnectStatus` :rtype: :class:`~oci.response.Response` """ @@ -3154,6 +3498,14 @@ def get_dhcp_options(self, dhcp_id, **kwargs): :param str dhcp_id: (required) The OCID for the set of DHCP options. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DhcpOptions` :rtype: :class:`~oci.response.Response` """ @@ -3210,6 +3562,14 @@ def get_drg(self, drg_id, **kwargs): :param str drg_id: (required) The OCID of the DRG. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Drg` :rtype: :class:`~oci.response.Response` """ @@ -3266,6 +3626,14 @@ def get_drg_attachment(self, drg_attachment_id, **kwargs): :param str drg_attachment_id: (required) The OCID of the DRG attachment. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DrgAttachment` :rtype: :class:`~oci.response.Response` """ @@ -3325,6 +3693,14 @@ def get_fast_connect_provider_service(self, provider_service_id, **kwargs): :param str provider_service_id: (required) The OCID of the provider service. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.FastConnectProviderService` :rtype: :class:`~oci.response.Response` """ @@ -3381,6 +3757,14 @@ def get_internet_gateway(self, ig_id, **kwargs): :param str ig_id: (required) The OCID of the Internet Gateway. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InternetGateway` :rtype: :class:`~oci.response.Response` """ @@ -3439,6 +3823,14 @@ def get_ip_sec_connection(self, ipsc_id, **kwargs): :param str ipsc_id: (required) The OCID of the IPSec connection. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnection` :rtype: :class:`~oci.response.Response` """ @@ -3496,6 +3888,14 @@ def get_ip_sec_connection_device_config(self, ipsc_id, **kwargs): :param str ipsc_id: (required) The OCID of the IPSec connection. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnectionDeviceConfig` :rtype: :class:`~oci.response.Response` """ @@ -3552,6 +3952,14 @@ def get_ip_sec_connection_device_status(self, ipsc_id, **kwargs): :param str ipsc_id: (required) The OCID of the IPSec connection. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnectionDeviceStatus` :rtype: :class:`~oci.response.Response` """ @@ -3608,6 +4016,14 @@ def get_local_peering_gateway(self, local_peering_gateway_id, **kwargs): :param str local_peering_gateway_id: (required) The OCID of the local peering gateway. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.LocalPeeringGateway` :rtype: :class:`~oci.response.Response` """ @@ -3667,6 +4083,14 @@ def get_private_ip(self, private_ip_id, **kwargs): :param str private_ip_id: (required) The OCID of the private IP. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PrivateIp` :rtype: :class:`~oci.response.Response` """ @@ -3733,6 +4157,14 @@ def get_public_ip(self, public_ip_id, **kwargs): :param str public_ip_id: (required) The OCID of the public IP. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PublicIp` :rtype: :class:`~oci.response.Response` """ @@ -3793,6 +4225,14 @@ def get_public_ip_by_ip_address(self, get_public_ip_by_ip_address_details, **kwa :param GetPublicIpByIpAddressDetails get_public_ip_by_ip_address_details: (required) IP address details for fetching the public IP. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PublicIp` :rtype: :class:`~oci.response.Response` """ @@ -3849,6 +4289,14 @@ def get_public_ip_by_private_ip_id(self, get_public_ip_by_private_ip_id_details, :param GetPublicIpByPrivateIpIdDetails get_public_ip_by_private_ip_id_details: (required) Private IP details for fetching the public IP. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PublicIp` :rtype: :class:`~oci.response.Response` """ @@ -3895,6 +4343,14 @@ def get_remote_peering_connection(self, remote_peering_connection_id, **kwargs): :param str remote_peering_connection_id: (required) The OCID of the remote peering connection (RPC). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.RemotePeeringConnection` :rtype: :class:`~oci.response.Response` """ @@ -3951,6 +4407,14 @@ def get_route_table(self, rt_id, **kwargs): :param str rt_id: (required) The OCID of the route table. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.RouteTable` :rtype: :class:`~oci.response.Response` """ @@ -4007,6 +4471,14 @@ def get_security_list(self, security_list_id, **kwargs): :param str security_list_id: (required) The OCID of the security list. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.SecurityList` :rtype: :class:`~oci.response.Response` """ @@ -4063,6 +4535,14 @@ def get_subnet(self, subnet_id, **kwargs): :param str subnet_id: (required) The OCID of the subnet. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Subnet` :rtype: :class:`~oci.response.Response` """ @@ -4119,6 +4599,14 @@ def get_vcn(self, vcn_id, **kwargs): :param str vcn_id: (required) The OCID of the VCN. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vcn` :rtype: :class:`~oci.response.Response` """ @@ -4175,6 +4663,14 @@ def get_virtual_circuit(self, virtual_circuit_id, **kwargs): :param str virtual_circuit_id: (required) The OCID of the virtual circuit. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VirtualCircuit` :rtype: :class:`~oci.response.Response` """ @@ -4231,8 +4727,16 @@ def get_vnic(self, vnic_id, **kwargs): operation. - :param str vnic_id: (required) - The OCID of the VNIC. + :param str vnic_id: (required) + The OCID of the VNIC. + + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vnic` :rtype: :class:`~oci.response.Response` @@ -4290,6 +4794,14 @@ def list_allowed_peer_regions_for_remote_peering(self, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.PeerRegionForRemotePeering` :rtype: :class:`~oci.response.Response` """ @@ -4342,6 +4854,14 @@ def list_cpes(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Cpe` :rtype: :class:`~oci.response.Response` """ @@ -4434,6 +4954,14 @@ def list_cross_connect_groups(self, compartment_id, **kwargs): Allowed values are: "PROVISIONING", "PROVISIONED", "INACTIVE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.CrossConnectGroup` :rtype: :class:`~oci.response.Response` """ @@ -4530,6 +5058,14 @@ def list_cross_connect_locations(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.CrossConnectLocation` :rtype: :class:`~oci.response.Response` """ @@ -4626,6 +5162,14 @@ def list_cross_connects(self, compartment_id, **kwargs): Allowed values are: "PENDING_CUSTOMER", "PROVISIONING", "PROVISIONED", "INACTIVE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.CrossConnect` :rtype: :class:`~oci.response.Response` """ @@ -4725,6 +5269,14 @@ def list_crossconnect_port_speed_shapes(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.CrossConnectPortSpeedShape` :rtype: :class:`~oci.response.Response` """ @@ -4822,6 +5374,14 @@ def list_dhcp_options(self, compartment_id, vcn_id, **kwargs): Allowed values are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.DhcpOptions` :rtype: :class:`~oci.response.Response` """ @@ -4925,6 +5485,14 @@ def list_drg_attachments(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.DrgAttachment` :rtype: :class:`~oci.response.Response` """ @@ -4995,6 +5563,14 @@ def list_drgs(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Drg` :rtype: :class:`~oci.response.Response` """ @@ -5069,6 +5645,14 @@ def list_fast_connect_provider_services(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.FastConnectProviderService` :rtype: :class:`~oci.response.Response` """ @@ -5140,6 +5724,14 @@ def list_fast_connect_provider_virtual_circuit_bandwidth_shapes(self, provider_s :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VirtualCircuitBandwidthShape` :rtype: :class:`~oci.response.Response` """ @@ -5246,6 +5838,14 @@ def list_internet_gateways(self, compartment_id, vcn_id, **kwargs): Allowed values are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.InternetGateway` :rtype: :class:`~oci.response.Response` """ @@ -5349,6 +5949,14 @@ def list_ip_sec_connections(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.IPSecConnection` :rtype: :class:`~oci.response.Response` """ @@ -5423,6 +6031,14 @@ def list_local_peering_gateways(self, compartment_id, vcn_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.LocalPeeringGateway` :rtype: :class:`~oci.response.Response` """ @@ -5510,6 +6126,14 @@ def list_private_ips(self, **kwargs): :param str vnic_id: (optional) The OCID of the VNIC. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.PrivateIp` :rtype: :class:`~oci.response.Response` """ @@ -5606,6 +6230,14 @@ def list_public_ips(self, scope, compartment_id, **kwargs): Example: `Uocm:PHX-AD-1` + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.PublicIp` :rtype: :class:`~oci.response.Response` """ @@ -5685,6 +6317,14 @@ def list_remote_peering_connections(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.RemotePeeringConnection` :rtype: :class:`~oci.response.Response` """ @@ -5784,6 +6424,14 @@ def list_route_tables(self, compartment_id, vcn_id, **kwargs): Allowed values are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.RouteTable` :rtype: :class:`~oci.response.Response` """ @@ -5909,6 +6557,14 @@ def list_security_lists(self, compartment_id, vcn_id, **kwargs): Allowed values are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.SecurityList` :rtype: :class:`~oci.response.Response` """ @@ -6034,6 +6690,14 @@ def list_subnets(self, compartment_id, vcn_id, **kwargs): Allowed values are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Subnet` :rtype: :class:`~oci.response.Response` """ @@ -6156,6 +6820,14 @@ def list_vcns(self, compartment_id, **kwargs): Allowed values are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Vcn` :rtype: :class:`~oci.response.Response` """ @@ -6251,6 +6923,14 @@ def list_virtual_circuit_bandwidth_shapes(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VirtualCircuitBandwidthShape` :rtype: :class:`~oci.response.Response` """ @@ -6316,6 +6996,14 @@ def list_virtual_circuit_public_prefixes(self, virtual_circuit_id, **kwargs): Allowed values are: "IN_PROGRESS", "COMPLETED", "FAILED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VirtualCircuitPublicPrefix` :rtype: :class:`~oci.response.Response` """ @@ -6424,6 +7112,14 @@ def list_virtual_circuits(self, compartment_id, **kwargs): Allowed values are: "PENDING_PROVIDER", "VERIFYING", "PROVISIONING", "PROVISIONED", "FAILED", "INACTIVE", "TERMINATING", "TERMINATED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VirtualCircuit` :rtype: :class:`~oci.response.Response` """ @@ -6520,6 +7216,14 @@ def update_cpe(self, cpe_id, update_cpe_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Cpe` :rtype: :class:`~oci.response.Response` """ @@ -6592,6 +7296,14 @@ def update_cross_connect(self, cross_connect_id, update_cross_connect_details, * 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnect` :rtype: :class:`~oci.response.Response` """ @@ -6665,6 +7377,14 @@ def update_cross_connect_group(self, cross_connect_group_id, update_cross_connec 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnectGroup` :rtype: :class:`~oci.response.Response` """ @@ -6740,6 +7460,14 @@ def update_dhcp_options(self, dhcp_id, update_dhcp_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DhcpOptions` :rtype: :class:`~oci.response.Response` """ @@ -6812,6 +7540,14 @@ def update_drg(self, drg_id, update_drg_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Drg` :rtype: :class:`~oci.response.Response` """ @@ -6885,6 +7621,14 @@ def update_drg_attachment(self, drg_attachment_id, update_drg_attachment_details 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DrgAttachment` :rtype: :class:`~oci.response.Response` """ @@ -6961,6 +7705,14 @@ def update_internet_gateway(self, ig_id, update_internet_gateway_details, **kwar 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InternetGateway` :rtype: :class:`~oci.response.Response` """ @@ -7034,6 +7786,14 @@ def update_ip_sec_connection(self, ipsc_id, update_ip_sec_connection_details, ** 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnection` :rtype: :class:`~oci.response.Response` """ @@ -7106,6 +7866,14 @@ def update_local_peering_gateway(self, local_peering_gateway_id, update_local_pe 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.LocalPeeringGateway` :rtype: :class:`~oci.response.Response` """ @@ -7187,6 +7955,14 @@ def update_private_ip(self, private_ip_id, update_private_ip_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PrivateIp` :rtype: :class:`~oci.response.Response` """ @@ -7251,7 +8027,7 @@ def update_public_ip(self, public_ip_id, update_public_ip_details, **kwargs): * Move a reserved public IP to a different private IP. * Unassign a reserved public IP from a private IP (which returns it to your pool of reserved public IPs). - * Change the display name for a public IP (either ephemeral or reserved). + * Change the display name for a public IP. Assigning, moving, and unassigning a reserved public IP are asynchronous operations. Poll the public IP's `lifecycleState` to determine if the operation @@ -7299,6 +8075,14 @@ def update_public_ip(self, public_ip_id, update_public_ip_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PublicIp` :rtype: :class:`~oci.response.Response` """ @@ -7371,6 +8155,14 @@ def update_remote_peering_connection(self, remote_peering_connection_id, update_ 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.RemotePeeringConnection` :rtype: :class:`~oci.response.Response` """ @@ -7446,6 +8238,14 @@ def update_route_table(self, rt_id, update_route_table_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.RouteTable` :rtype: :class:`~oci.response.Response` """ @@ -7522,6 +8322,14 @@ def update_security_list(self, security_list_id, update_security_list_details, * 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.SecurityList` :rtype: :class:`~oci.response.Response` """ @@ -7594,6 +8402,14 @@ def update_subnet(self, subnet_id, update_subnet_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Subnet` :rtype: :class:`~oci.response.Response` """ @@ -7667,6 +8483,14 @@ def update_vcn(self, vcn_id, update_vcn_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vcn` :rtype: :class:`~oci.response.Response` """ @@ -7764,6 +8588,14 @@ def update_virtual_circuit(self, virtual_circuit_id, update_virtual_circuit_deta 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VirtualCircuit` :rtype: :class:`~oci.response.Response` """ @@ -7836,6 +8668,14 @@ def update_vnic(self, vnic_id, update_vnic_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vnic` :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/database/database_client.py b/src/oci/database/database_client.py index c50cda1f65..77c1b35cab 100644 --- a/src/oci/database/database_client.py +++ b/src/oci/database/database_client.py @@ -94,6 +94,14 @@ def create_backup(self, create_backup_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.Backup` :rtype: :class:`~oci.response.Response` """ @@ -170,6 +178,14 @@ def create_data_guard_association(self, database_id, create_data_guard_associati has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DataGuardAssociation` :rtype: :class:`~oci.response.Response` """ @@ -243,6 +259,14 @@ def create_db_home(self, create_db_home_with_db_system_id_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbHome` :rtype: :class:`~oci.response.Response` """ @@ -330,6 +354,14 @@ def db_node_action(self, db_node_id, action, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbNode` :rtype: :class:`~oci.response.Response` """ @@ -408,6 +440,14 @@ def delete_backup(self, backup_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -478,6 +518,14 @@ def delete_db_home(self, db_home_id, **kwargs): :param bool perform_final_backup: (optional) Whether to perform a final backup of the database or not. Default is false. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -565,6 +613,14 @@ def failover_data_guard_association(self, database_id, data_guard_association_id 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DataGuardAssociation` :rtype: :class:`~oci.response.Response` """ @@ -630,6 +686,14 @@ def get_backup(self, backup_id, **kwargs): :param str backup_id: (required) The backup OCID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.Backup` :rtype: :class:`~oci.response.Response` """ @@ -693,6 +757,14 @@ def get_data_guard_association(self, database_id, data_guard_association_id, **k __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DataGuardAssociation` :rtype: :class:`~oci.response.Response` """ @@ -752,6 +824,14 @@ def get_database(self, database_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.Database` :rtype: :class:`~oci.response.Response` """ @@ -810,6 +890,14 @@ def get_db_home(self, db_home_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbHome` :rtype: :class:`~oci.response.Response` """ @@ -871,6 +959,14 @@ def get_db_home_patch(self, db_home_id, patch_id, **kwargs): :param str patch_id: (required) The OCID of the patch. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.Patch` :rtype: :class:`~oci.response.Response` """ @@ -933,6 +1029,14 @@ def get_db_home_patch_history_entry(self, db_home_id, patch_history_entry_id, ** :param str patch_history_entry_id: (required) The OCID of the patch history entry. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.PatchHistoryEntry` :rtype: :class:`~oci.response.Response` """ @@ -992,6 +1096,14 @@ def get_db_node(self, db_node_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbNode` :rtype: :class:`~oci.response.Response` """ @@ -1050,6 +1162,14 @@ def get_db_system(self, db_system_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbSystem` :rtype: :class:`~oci.response.Response` """ @@ -1111,6 +1231,14 @@ def get_db_system_patch(self, db_system_id, patch_id, **kwargs): :param str patch_id: (required) The OCID of the patch. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.Patch` :rtype: :class:`~oci.response.Response` """ @@ -1173,6 +1301,14 @@ def get_db_system_patch_history_entry(self, db_system_id, patch_history_entry_id :param str patch_history_entry_id: (required) The OCID of the patch history entry. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.PatchHistoryEntry` :rtype: :class:`~oci.response.Response` """ @@ -1249,6 +1385,14 @@ def launch_db_system(self, launch_db_system_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbSystem` :rtype: :class:`~oci.response.Response` """ @@ -1312,6 +1456,14 @@ def list_backups(self, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.BackupSummary` :rtype: :class:`~oci.response.Response` """ @@ -1381,6 +1533,14 @@ def list_data_guard_associations(self, database_id, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DataGuardAssociationSummary` :rtype: :class:`~oci.response.Response` """ @@ -1463,6 +1623,14 @@ def list_databases(self, compartment_id, db_home_id, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DatabaseSummary` :rtype: :class:`~oci.response.Response` """ @@ -1530,6 +1698,14 @@ def list_db_home_patch_history_entries(self, db_home_id, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.PatchHistoryEntrySummary` :rtype: :class:`~oci.response.Response` """ @@ -1607,6 +1783,14 @@ def list_db_home_patches(self, db_home_id, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.PatchSummary` :rtype: :class:`~oci.response.Response` """ @@ -1689,6 +1873,14 @@ def list_db_homes(self, compartment_id, db_system_id, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbHomeSummary` :rtype: :class:`~oci.response.Response` """ @@ -1761,6 +1953,14 @@ def list_db_nodes(self, compartment_id, db_system_id, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbNodeSummary` :rtype: :class:`~oci.response.Response` """ @@ -1828,6 +2028,14 @@ def list_db_system_patch_history_entries(self, db_system_id, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.PatchHistoryEntrySummary` :rtype: :class:`~oci.response.Response` """ @@ -1905,6 +2113,14 @@ def list_db_system_patches(self, db_system_id, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.PatchSummary` :rtype: :class:`~oci.response.Response` """ @@ -1985,6 +2201,14 @@ def list_db_system_shapes(self, availability_domain, compartment_id, **kwargs): :param str page: (optional) The pagination token to continue listing from. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbSystemShapeSummary` :rtype: :class:`~oci.response.Response` """ @@ -2055,6 +2279,14 @@ def list_db_systems(self, compartment_id, **kwargs): :param str backup_id: (optional) The OCID of the backup. Specify a backupId to list only the DB Systems that support creating a database using this backup in this compartment. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbSystemSummary` :rtype: :class:`~oci.response.Response` """ @@ -2129,6 +2361,14 @@ def list_db_versions(self, compartment_id, **kwargs): :param str db_system_id: (optional) The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbVersionSummary` :rtype: :class:`~oci.response.Response` """ @@ -2206,6 +2446,14 @@ def reinstate_data_guard_association(self, database_id, data_guard_association_i 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DataGuardAssociation` :rtype: :class:`~oci.response.Response` """ @@ -2281,6 +2529,14 @@ def restore_database(self, database_id, restore_database_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.Database` :rtype: :class:`~oci.response.Response` """ @@ -2363,6 +2619,14 @@ def switchover_data_guard_association(self, database_id, data_guard_association_ 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DataGuardAssociation` :rtype: :class:`~oci.response.Response` """ @@ -2435,6 +2699,14 @@ def terminate_db_system(self, db_system_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2505,6 +2777,14 @@ def update_database(self, database_id, update_database_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.Database` :rtype: :class:`~oci.response.Response` """ @@ -2579,6 +2859,14 @@ def update_db_home(self, db_home_id, update_db_home_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbHome` :rtype: :class:`~oci.response.Response` """ @@ -2653,6 +2941,14 @@ def update_db_system(self, db_system_id, update_db_system_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbSystem` :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/dns/dns_client.py b/src/oci/dns/dns_client.py index ebf81c0de9..0c4ebf05ef 100644 --- a/src/oci/dns/dns_client.py +++ b/src/oci/dns/dns_client.py @@ -91,6 +91,14 @@ def create_zone(self, create_zone_details, **kwargs): :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.Zone` :rtype: :class:`~oci.response.Response` """ @@ -167,6 +175,14 @@ def delete_domain_records(self, zone_name_or_id, domain, **kwargs): :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -260,6 +276,14 @@ def delete_rr_set(self, zone_name_or_id, domain, rtype, **kwargs): :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -349,6 +373,14 @@ def delete_zone(self, zone_name_or_id, **kwargs): :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -463,6 +495,14 @@ def get_domain_records(self, zone_name_or_id, domain, **kwargs): :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.RecordCollection` :rtype: :class:`~oci.response.Response` """ @@ -592,6 +632,14 @@ def get_rr_set(self, zone_name_or_id, domain, rtype, **kwargs): :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.RRSet` :rtype: :class:`~oci.response.Response` """ @@ -687,6 +735,14 @@ def get_zone(self, zone_name_or_id, **kwargs): :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.Zone` :rtype: :class:`~oci.response.Response` """ @@ -810,6 +866,14 @@ def get_zone_records(self, zone_name_or_id, **kwargs): :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.RecordCollection` :rtype: :class:`~oci.response.Response` """ @@ -959,6 +1023,14 @@ def list_zones(self, compartment_id, **kwargs): Allowed values are: "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.dns.models.ZoneSummary` :rtype: :class:`~oci.response.Response` """ @@ -1083,6 +1155,14 @@ def patch_domain_records(self, zone_name_or_id, domain, patch_domain_records_det :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.RecordCollection` :rtype: :class:`~oci.response.Response` """ @@ -1183,6 +1263,14 @@ def patch_rr_set(self, zone_name_or_id, domain, rtype, patch_rr_set_details, **k :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.RecordCollection` :rtype: :class:`~oci.response.Response` """ @@ -1281,6 +1369,14 @@ def patch_zone_records(self, zone_name_or_id, patch_zone_records_details, **kwar :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.RecordCollection` :rtype: :class:`~oci.response.Response` """ @@ -1382,6 +1478,14 @@ def update_domain_records(self, zone_name_or_id, domain, update_domain_records_d :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.RecordCollection` :rtype: :class:`~oci.response.Response` """ @@ -1482,6 +1586,14 @@ def update_rr_set(self, zone_name_or_id, domain, rtype, update_rr_set_details, * :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.RecordCollection` :rtype: :class:`~oci.response.Response` """ @@ -1581,6 +1693,14 @@ def update_zone(self, zone_name_or_id, update_zone_details, **kwargs): :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.Zone` :rtype: :class:`~oci.response.Response` """ @@ -1678,6 +1798,14 @@ def update_zone_records(self, zone_name_or_id, update_zone_records_details, **kw :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.RecordCollection` :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/email/email_client.py b/src/oci/email/email_client.py index 5f68a69b86..d96a3fadbd 100644 --- a/src/oci/email/email_client.py +++ b/src/oci/email/email_client.py @@ -87,6 +87,14 @@ def create_sender(self, create_sender_details, **kwargs): :param CreateSenderDetails create_sender_details: (required) Create a sender. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.email.models.Sender` :rtype: :class:`~oci.response.Response` """ @@ -133,6 +141,14 @@ def create_suppression(self, create_suppression_details, **kwargs): :param CreateSuppressionDetails create_suppression_details: (required) Adds a single email address to the suppression list for a compartment's tenancy. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.email.models.Suppression` :rtype: :class:`~oci.response.Response` """ @@ -180,6 +196,14 @@ def delete_sender(self, sender_id, **kwargs): :param str sender_id: (required) The unique OCID of the sender. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -235,6 +259,14 @@ def delete_suppression(self, suppression_id, **kwargs): :param str suppression_id: (required) The unique OCID of the suppression. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -289,6 +321,14 @@ def get_sender(self, sender_id, **kwargs): :param str sender_id: (required) The unique OCID of the sender. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.email.models.Sender` :rtype: :class:`~oci.response.Response` """ @@ -346,6 +386,14 @@ def get_suppression(self, suppression_id, **kwargs): :param str suppression_id: (required) The unique OCID of the suppression. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.email.models.Suppression` :rtype: :class:`~oci.response.Response` """ @@ -430,6 +478,14 @@ def list_senders(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.email.models.SenderSummary` :rtype: :class:`~oci.response.Response` """ @@ -562,6 +618,14 @@ def list_suppressions(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.email.models.SuppressionSummary` :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/file_storage/file_storage_client.py b/src/oci/file_storage/file_storage_client.py index 3560bed332..395fd07705 100644 --- a/src/oci/file_storage/file_storage_client.py +++ b/src/oci/file_storage/file_storage_client.py @@ -95,6 +95,14 @@ def create_export(self, create_export_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request might be rejected. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.Export` :rtype: :class:`~oci.response.Response` """ @@ -184,6 +192,14 @@ def create_file_system(self, create_file_system_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request might be rejected. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.FileSystem` :rtype: :class:`~oci.response.Response` """ @@ -279,6 +295,14 @@ def create_mount_target(self, create_mount_target_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request might be rejected. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.MountTarget` :rtype: :class:`~oci.response.Response` """ @@ -341,6 +365,14 @@ def create_snapshot(self, create_snapshot_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request might be rejected. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.Snapshot` :rtype: :class:`~oci.response.Response` """ @@ -402,6 +434,14 @@ def delete_export(self, export_id, **kwargs): The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -471,6 +511,14 @@ def delete_file_system(self, file_system_id, **kwargs): The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -539,6 +587,14 @@ def delete_mount_target(self, mount_target_id, **kwargs): The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -606,6 +662,14 @@ def delete_snapshot(self, snapshot_id, **kwargs): The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -666,6 +730,14 @@ def get_export(self, export_id, **kwargs): :param str export_id: (required) The OCID of the export. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.Export` :rtype: :class:`~oci.response.Response` """ @@ -722,6 +794,14 @@ def get_export_set(self, export_set_id, **kwargs): :param str export_set_id: (required) The OCID of the export set. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.ExportSet` :rtype: :class:`~oci.response.Response` """ @@ -778,6 +858,14 @@ def get_file_system(self, file_system_id, **kwargs): :param str file_system_id: (required) The OCID of the file system. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.FileSystem` :rtype: :class:`~oci.response.Response` """ @@ -834,6 +922,14 @@ def get_mount_target(self, mount_target_id, **kwargs): :param str mount_target_id: (required) The OCID of the mount target. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.MountTarget` :rtype: :class:`~oci.response.Response` """ @@ -890,6 +986,14 @@ def get_snapshot(self, snapshot_id, **kwargs): :param str snapshot_id: (required) The OCID of the snapshot. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.Snapshot` :rtype: :class:`~oci.response.Response` """ @@ -988,6 +1092,14 @@ def list_export_sets(self, compartment_id, availability_domain, **kwargs): Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.file_storage.models.ExportSetSummary` :rtype: :class:`~oci.response.Response` """ @@ -1117,6 +1229,14 @@ def list_exports(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.file_storage.models.ExportSummary` :rtype: :class:`~oci.response.Response` """ @@ -1250,6 +1370,14 @@ def list_file_systems(self, compartment_id, availability_domain, **kwargs): Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.file_storage.models.FileSystemSummary` :rtype: :class:`~oci.response.Response` """ @@ -1385,6 +1513,14 @@ def list_mount_targets(self, compartment_id, availability_domain, **kwargs): Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.file_storage.models.MountTargetSummary` :rtype: :class:`~oci.response.Response` """ @@ -1501,6 +1637,14 @@ def list_snapshots(self, file_system_id, **kwargs): Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.file_storage.models.SnapshotSummary` :rtype: :class:`~oci.response.Response` """ @@ -1589,6 +1733,14 @@ def update_export_set(self, export_set_id, update_export_set_details, **kwargs): The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.ExportSet` :rtype: :class:`~oci.response.Response` """ @@ -1664,6 +1816,14 @@ def update_file_system(self, file_system_id, update_file_system_details, **kwarg The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.FileSystem` :rtype: :class:`~oci.response.Response` """ @@ -1738,6 +1898,14 @@ def update_mount_target(self, mount_target_id, update_mount_target_details, **kw The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.file_storage.models.MountTarget` :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/identity/identity_client.py b/src/oci/identity/identity_client.py index e83af8c12d..024b552efa 100644 --- a/src/oci/identity/identity_client.py +++ b/src/oci/identity/identity_client.py @@ -97,6 +97,14 @@ def add_user_to_group(self, add_user_to_group_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.UserGroupMembership` :rtype: :class:`~oci.response.Response` """ @@ -179,6 +187,14 @@ def create_compartment(self, create_compartment_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Compartment` :rtype: :class:`~oci.response.Response` """ @@ -255,6 +271,14 @@ def create_customer_secret_key(self, create_customer_secret_key_details, user_id has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.CustomerSecretKey` :rtype: :class:`~oci.response.Response` """ @@ -348,6 +372,14 @@ def create_dynamic_group(self, create_dynamic_group_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.DynamicGroup` :rtype: :class:`~oci.response.Response` """ @@ -432,6 +464,14 @@ def create_group(self, create_group_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Group` :rtype: :class:`~oci.response.Response` """ @@ -513,6 +553,14 @@ def create_identity_provider(self, create_identity_provider_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdentityProvider` :rtype: :class:`~oci.response.Response` """ @@ -578,6 +626,14 @@ def create_idp_group_mapping(self, create_idp_group_mapping_details, identity_pr has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdpGroupMapping` :rtype: :class:`~oci.response.Response` """ @@ -663,6 +719,14 @@ def create_or_reset_ui_password(self, user_id, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.UIPassword` :rtype: :class:`~oci.response.Response` """ @@ -754,6 +818,14 @@ def create_policy(self, create_policy_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Policy` :rtype: :class:`~oci.response.Response` """ @@ -818,6 +890,14 @@ def create_region_subscription(self, create_region_subscription_details, tenancy has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.RegionSubscription` :rtype: :class:`~oci.response.Response` """ @@ -897,6 +977,14 @@ def create_smtp_credential(self, create_smtp_credential_details, user_id, **kwar has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.SmtpCredential` :rtype: :class:`~oci.response.Response` """ @@ -984,6 +1072,14 @@ def create_swift_password(self, create_swift_password_details, user_id, **kwargs has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.SwiftPassword` :rtype: :class:`~oci.response.Response` """ @@ -1071,6 +1167,14 @@ def create_tag(self, tag_namespace_id, create_tag_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Tag` :rtype: :class:`~oci.response.Response` """ @@ -1162,6 +1266,14 @@ def create_tag_namespace(self, create_tag_namespace_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.TagNamespace` :rtype: :class:`~oci.response.Response` """ @@ -1261,6 +1373,14 @@ def create_user(self, create_user_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.User` :rtype: :class:`~oci.response.Response` """ @@ -1328,6 +1448,14 @@ def delete_api_key(self, user_id, fingerprint, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1397,6 +1525,14 @@ def delete_customer_secret_key(self, user_id, customer_secret_key_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1463,6 +1599,14 @@ def delete_dynamic_group(self, dynamic_group_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1528,6 +1672,14 @@ def delete_group(self, group_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1594,6 +1746,14 @@ def delete_identity_provider(self, identity_provider_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1662,6 +1822,14 @@ def delete_idp_group_mapping(self, identity_provider_id, mapping_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1728,6 +1896,14 @@ def delete_policy(self, policy_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1796,6 +1972,14 @@ def delete_smtp_credential(self, user_id, smtp_credential_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1865,6 +2049,14 @@ def delete_swift_password(self, user_id, swift_password_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1931,6 +2123,14 @@ def delete_user(self, user_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1998,6 +2198,14 @@ def get_compartment(self, compartment_id, **kwargs): :param str compartment_id: (required) The OCID of the compartment. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Compartment` :rtype: :class:`~oci.response.Response` """ @@ -2054,6 +2262,14 @@ def get_dynamic_group(self, dynamic_group_id, **kwargs): :param str dynamic_group_id: (required) The OCID of the dynamic group. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.DynamicGroup` :rtype: :class:`~oci.response.Response` """ @@ -2114,6 +2330,14 @@ def get_group(self, group_id, **kwargs): :param str group_id: (required) The OCID of the group. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Group` :rtype: :class:`~oci.response.Response` """ @@ -2170,6 +2394,14 @@ def get_identity_provider(self, identity_provider_id, **kwargs): :param str identity_provider_id: (required) The OCID of the identity provider. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdentityProvider` :rtype: :class:`~oci.response.Response` """ @@ -2229,6 +2461,14 @@ def get_idp_group_mapping(self, identity_provider_id, mapping_id, **kwargs): :param str mapping_id: (required) The OCID of the group mapping. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdpGroupMapping` :rtype: :class:`~oci.response.Response` """ @@ -2286,6 +2526,14 @@ def get_policy(self, policy_id, **kwargs): :param str policy_id: (required) The OCID of the policy. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Policy` :rtype: :class:`~oci.response.Response` """ @@ -2345,6 +2593,14 @@ def get_tag(self, tag_namespace_id, tag_name, **kwargs): :param str tag_name: (required) The name of the tag. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Tag` :rtype: :class:`~oci.response.Response` """ @@ -2402,6 +2658,14 @@ def get_tag_namespace(self, tag_namespace_id, **kwargs): :param str tag_namespace_id: (required) The OCID of the tag namespace. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.TagNamespace` :rtype: :class:`~oci.response.Response` """ @@ -2458,6 +2722,14 @@ def get_tenancy(self, tenancy_id, **kwargs): :param str tenancy_id: (required) The OCID of the tenancy. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Tenancy` :rtype: :class:`~oci.response.Response` """ @@ -2514,6 +2786,14 @@ def get_user(self, user_id, **kwargs): :param str user_id: (required) The OCID of the user. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.User` :rtype: :class:`~oci.response.Response` """ @@ -2570,6 +2850,14 @@ def get_user_group_membership(self, user_group_membership_id, **kwargs): :param str user_group_membership_id: (required) The OCID of the userGroupMembership. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.UserGroupMembership` :rtype: :class:`~oci.response.Response` """ @@ -2629,6 +2917,14 @@ def list_api_keys(self, user_id, **kwargs): :param str user_id: (required) The OCID of the user. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.ApiKey` :rtype: :class:`~oci.response.Response` """ @@ -2689,6 +2985,14 @@ def list_availability_domains(self, compartment_id, **kwargs): :param str compartment_id: (required) The OCID of the compartment (remember that the tenancy is simply the root compartment). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.AvailabilityDomain` :rtype: :class:`~oci.response.Response` """ @@ -2750,6 +3054,14 @@ def list_compartments(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.Compartment` :rtype: :class:`~oci.response.Response` """ @@ -2809,6 +3121,14 @@ def list_customer_secret_keys(self, user_id, **kwargs): :param str user_id: (required) The OCID of the user. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.CustomerSecretKeySummary` :rtype: :class:`~oci.response.Response` """ @@ -2875,6 +3195,14 @@ def list_dynamic_groups(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.DynamicGroup` :rtype: :class:`~oci.response.Response` """ @@ -2943,6 +3271,14 @@ def list_groups(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.Group` :rtype: :class:`~oci.response.Response` """ @@ -3017,6 +3353,14 @@ def list_identity_providers(self, protocol, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.IdentityProvider` :rtype: :class:`~oci.response.Response` """ @@ -3082,6 +3426,14 @@ def list_idp_group_mappings(self, identity_provider_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.IdpGroupMapping` :rtype: :class:`~oci.response.Response` """ @@ -3163,6 +3515,14 @@ def list_policies(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.Policy` :rtype: :class:`~oci.response.Response` """ @@ -3221,6 +3581,14 @@ def list_region_subscriptions(self, tenancy_id, **kwargs): :param str tenancy_id: (required) The OCID of the tenancy. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.RegionSubscription` :rtype: :class:`~oci.response.Response` """ @@ -3274,6 +3642,14 @@ def list_regions(self, **kwargs): Lists all the regions offered by Oracle Cloud Infrastructure. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.Region` :rtype: :class:`~oci.response.Response` """ @@ -3319,6 +3695,14 @@ def list_smtp_credentials(self, user_id, **kwargs): :param str user_id: (required) The OCID of the user. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.SmtpCredentialSummary` :rtype: :class:`~oci.response.Response` """ @@ -3376,6 +3760,14 @@ def list_swift_passwords(self, user_id, **kwargs): :param str user_id: (required) The OCID of the user. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.SwiftPassword` :rtype: :class:`~oci.response.Response` """ @@ -3442,6 +3834,14 @@ def list_tag_namespaces(self, compartment_id, **kwargs): An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.TagNamespaceSummary` :rtype: :class:`~oci.response.Response` """ @@ -3508,6 +3908,14 @@ def list_tags(self, tag_namespace_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.TagSummary` :rtype: :class:`~oci.response.Response` """ @@ -3600,6 +4008,14 @@ def list_user_group_memberships(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.UserGroupMembership` :rtype: :class:`~oci.response.Response` """ @@ -3672,6 +4088,14 @@ def list_users(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.User` :rtype: :class:`~oci.response.Response` """ @@ -3735,6 +4159,14 @@ def remove_user_from_group(self, user_group_membership_id, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -3803,6 +4235,14 @@ def update_compartment(self, compartment_id, update_compartment_details, **kwarg 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Compartment` :rtype: :class:`~oci.response.Response` """ @@ -3878,6 +4318,14 @@ def update_customer_secret_key(self, user_id, customer_secret_key_id, update_cus 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.CustomerSecretKeySummary` :rtype: :class:`~oci.response.Response` """ @@ -3951,6 +4399,14 @@ def update_dynamic_group(self, dynamic_group_id, update_dynamic_group_details, * 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.DynamicGroup` :rtype: :class:`~oci.response.Response` """ @@ -4023,6 +4479,14 @@ def update_group(self, group_id, update_group_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Group` :rtype: :class:`~oci.response.Response` """ @@ -4095,6 +4559,14 @@ def update_identity_provider(self, identity_provider_id, update_identity_provide 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdentityProvider` :rtype: :class:`~oci.response.Response` """ @@ -4170,6 +4642,14 @@ def update_idp_group_mapping(self, identity_provider_id, mapping_id, update_idp_ 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdpGroupMapping` :rtype: :class:`~oci.response.Response` """ @@ -4245,6 +4725,14 @@ def update_policy(self, policy_id, update_policy_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Policy` :rtype: :class:`~oci.response.Response` """ @@ -4320,6 +4808,14 @@ def update_smtp_credential(self, user_id, smtp_credential_id, update_smtp_creden 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.SmtpCredentialSummary` :rtype: :class:`~oci.response.Response` """ @@ -4396,6 +4892,14 @@ def update_swift_password(self, user_id, swift_password_id, update_swift_passwor 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.SwiftPassword` :rtype: :class:`~oci.response.Response` """ @@ -4467,6 +4971,14 @@ def update_tag(self, tag_namespace_id, tag_name, update_tag_details, **kwargs): :param UpdateTagDetails update_tag_details: (required) Request object for updating a tag. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Tag` :rtype: :class:`~oci.response.Response` """ @@ -4539,6 +5051,14 @@ def update_tag_namespace(self, tag_namespace_id, update_tag_namespace_details, * :param UpdateTagNamespaceDetails update_tag_namespace_details: (required) Request object for updating a namespace. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.TagNamespace` :rtype: :class:`~oci.response.Response` """ @@ -4605,6 +5125,14 @@ def update_user(self, user_id, update_user_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.User` :rtype: :class:`~oci.response.Response` """ @@ -4677,6 +5205,14 @@ def update_user_state(self, user_id, update_state_details, **kwargs): 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 you provide matches the resource's current etag value. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.User` :rtype: :class:`~oci.response.Response` """ @@ -4765,6 +5301,14 @@ def upload_api_key(self, user_id, create_api_key_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.ApiKey` :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/load_balancer/load_balancer_client.py b/src/oci/load_balancer/load_balancer_client.py index 5586846286..855460d56b 100644 --- a/src/oci/load_balancer/load_balancer_client.py +++ b/src/oci/load_balancer/load_balancer_client.py @@ -95,7 +95,7 @@ def create_backend(self, create_backend_details, load_balancer_id, backend_set_n :param str backend_set_name: (required) The name of the backend set to add the backend server to. - Example: `My_backend_set` + Example: `example_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -108,6 +108,14 @@ def create_backend(self, create_backend_details, load_balancer_id, backend_set_n has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -191,6 +199,14 @@ def create_backend_set(self, create_backend_set_details, load_balancer_id, **kwa has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -251,14 +267,14 @@ def create_backend_set(self, create_backend_set_details, load_balancer_id, **kwa def create_certificate(self, create_certificate_details, load_balancer_id, **kwargs): """ CreateCertificate - Creates an asynchronous request to add an SSL certificate. + Creates an asynchronous request to add an SSL certificate bundle. :param CreateCertificateDetails create_certificate_details: (required) - The details of the certificate to add. + The details of the certificate bundle to add. :param str load_balancer_id: (required) - The `OCID`__ of the load balancer on which to add the certificate. + The `OCID`__ of the load balancer on which to add the certificate bundle. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -273,6 +289,14 @@ def create_certificate(self, create_certificate_details, load_balancer_id, **kwa has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -330,6 +354,99 @@ def create_certificate(self, create_certificate_details, load_balancer_id, **kwa header_params=header_params, body=create_certificate_details) + def create_hostname(self, create_hostname_details, load_balancer_id, **kwargs): + """ + CreateHostname + Adds a hostname resource to the specified load balancer. For more information, see + `Managing Request Routing`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm + + + :param CreateHostnameDetails create_hostname_details: (required) + The details of the hostname resource to add to the specified load balancer. + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer to add the hostname to. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param str opc_retry_token: (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 (e.g., if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/loadBalancers/{loadBalancerId}/hostnames" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_hostname got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "loadBalancerId": load_balancer_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_hostname_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_hostname_details) + def create_listener(self, create_listener_details, load_balancer_id, **kwargs): """ CreateListener @@ -355,6 +472,14 @@ def create_listener(self, create_listener_details, load_balancer_id, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -463,6 +588,14 @@ def create_load_balancer(self, create_load_balancer_details, **kwargs): has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -536,6 +669,14 @@ def create_path_route_set(self, create_path_route_set_details, load_balancer_id, has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -607,17 +748,25 @@ def delete_backend(self, load_balancer_id, backend_set_name, backend_name, **kwa :param str backend_set_name: (required) The name of the backend set associated with the backend server. - Example: `My_backend_set` + Example: `example_backend_set` :param str backend_name: (required) The IP address and port of the backend server to remove. - Example: `1.1.1.7:42` + Example: `10.0.0.3:8080` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -687,12 +836,20 @@ def delete_backend_set(self, load_balancer_id, backend_set_name, **kwargs): :param str backend_set_name: (required) The name of the backend set to delete. - Example: `My_backend_set` + Example: `example_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -748,23 +905,32 @@ def delete_backend_set(self, load_balancer_id, backend_set_name, **kwargs): def delete_certificate(self, load_balancer_id, certificate_name, **kwargs): """ DeleteCertificate - Deletes an SSL certificate from a load balancer. + Deletes an SSL certificate bundle from a load balancer. :param str load_balancer_id: (required) - The `OCID`__ of the load balancer associated with the certificate to be deleted. + The `OCID`__ of the load balancer associated with the certificate bundle + to be deleted. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str certificate_name: (required) - The name of the certificate to delete. + The name of the certificate bundle to delete. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -817,6 +983,86 @@ def delete_certificate(self, load_balancer_id, certificate_name, **kwargs): path_params=path_params, header_params=header_params) + def delete_hostname(self, load_balancer_id, name, **kwargs): + """ + DeleteHostname + Deletes a hostname resource from the specified load balancer. + + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer associated with the hostname to delete. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :param str name: (required) + The name of the hostname resource to delete. + + Example: `example_hostname_001` + + :param str opc_request_id: (optional) + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/loadBalancers/{loadBalancerId}/hostnames/{name}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_hostname got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "loadBalancerId": load_balancer_id, + "name": name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + def delete_listener(self, load_balancer_id, listener_name, **kwargs): """ DeleteListener @@ -831,12 +1077,20 @@ def delete_listener(self, load_balancer_id, listener_name, **kwargs): :param str listener_name: (required) The name of the listener to delete. - Example: `My listener` + Example: `example_listener` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -904,6 +1158,14 @@ def delete_load_balancer(self, load_balancer_id, **kwargs): The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -972,12 +1234,20 @@ def delete_path_route_set(self, load_balancer_id, path_route_set_name, **kwargs) :param str path_route_set_name: (required) The name of the path route set to delete. - Example: `path-route-set-001` + Example: `example_path_route_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1044,17 +1314,25 @@ def get_backend(self, load_balancer_id, backend_set_name, backend_name, **kwargs :param str backend_set_name: (required) The name of the backend set that includes the backend server. - Example: `My_backend_set` + Example: `example_backend_set` :param str backend_name: (required) The IP address and port of the backend server to retrieve. - Example: `1.1.1.7:42` + Example: `10.0.0.3:8080` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.Backend` :rtype: :class:`~oci.response.Response` """ @@ -1124,17 +1402,25 @@ def get_backend_health(self, load_balancer_id, backend_set_name, backend_name, * :param str backend_set_name: (required) The name of the backend set associated with the backend server to retrieve the health status for. - Example: `My_backend_set` + Example: `example_backend_set` :param str backend_name: (required) The IP address and port of the backend server to retrieve the health status for. - Example: `1.1.1.7:42` + Example: `10.0.0.3:8080` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.BackendHealth` :rtype: :class:`~oci.response.Response` """ @@ -1204,12 +1490,20 @@ def get_backend_set(self, load_balancer_id, backend_set_name, **kwargs): :param str backend_set_name: (required) The name of the backend set to retrieve. - Example: `My_backend_set` + Example: `example_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.BackendSet` :rtype: :class:`~oci.response.Response` """ @@ -1278,12 +1572,20 @@ def get_backend_set_health(self, load_balancer_id, backend_set_name, **kwargs): :param str backend_set_name: (required) The name of the backend set to retrieve the health status for. - Example: `My_backend_set` + Example: `example_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.BackendSetHealth` :rtype: :class:`~oci.response.Response` """ @@ -1352,12 +1654,20 @@ def get_health_checker(self, load_balancer_id, backend_set_name, **kwargs): :param str backend_set_name: (required) The name of the backend set associated with the health check policy to be retrieved. - Example: `My_backend_set` + Example: `example_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.HealthChecker` :rtype: :class:`~oci.response.Response` """ @@ -1412,6 +1722,88 @@ def get_health_checker(self, load_balancer_id, backend_set_name, **kwargs): header_params=header_params, response_type="HealthChecker") + def get_hostname(self, load_balancer_id, name, **kwargs): + """ + GetHostname + Gets the specified hostname resource's configuration information. + + + :param str load_balancer_id: (required) + The `OCID`__ of the specified load balancer. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :param str name: (required) + The name of the hostname resource to retrieve. + + Example: `example_hostname_001` + + :param str opc_request_id: (optional) + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.Hostname` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/loadBalancers/{loadBalancerId}/hostnames/{name}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_hostname got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "loadBalancerId": load_balancer_id, + "name": name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Hostname") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Hostname") + def get_load_balancer(self, load_balancer_id, **kwargs): """ GetLoadBalancer @@ -1423,9 +1815,17 @@ def get_load_balancer(self, load_balancer_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm - :param str opc_request_id: (optional) - The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a - particular request, please provide the request ID. + :param str opc_request_id: (optional) + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.LoadBalancer` :rtype: :class:`~oci.response.Response` @@ -1495,6 +1895,14 @@ def get_load_balancer_health(self, load_balancer_id, **kwargs): The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.LoadBalancerHealth` :rtype: :class:`~oci.response.Response` """ @@ -1562,12 +1970,20 @@ def get_path_route_set(self, load_balancer_id, path_route_set_name, **kwargs): :param str path_route_set_name: (required) The name of the path route set to retrieve. - Example: `path-route-set-001` + Example: `example_path_route_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.PathRouteSet` :rtype: :class:`~oci.response.Response` """ @@ -1637,6 +2053,14 @@ def get_work_request(self, work_request_id, **kwargs): The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.WorkRequest` :rtype: :class:`~oci.response.Response` """ @@ -1705,6 +2129,14 @@ def list_backend_sets(self, load_balancer_id, **kwargs): The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.BackendSet` :rtype: :class:`~oci.response.Response` """ @@ -1772,12 +2204,20 @@ def list_backends(self, load_balancer_id, backend_set_name, **kwargs): :param str backend_set_name: (required) The name of the backend set associated with the backend servers. - Example: `My_backend_set` + Example: `example_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.Backend` :rtype: :class:`~oci.response.Response` """ @@ -1835,11 +2275,12 @@ def list_backends(self, load_balancer_id, backend_set_name, **kwargs): def list_certificates(self, load_balancer_id, **kwargs): """ ListCertificates - Lists all SSL certificates associated with a given load balancer. + Lists all SSL certificates bundles associated with a given load balancer. :param str load_balancer_id: (required) - The `OCID`__ of the load balancer associated with the certificates to be listed. + The `OCID`__ of the load balancer associated with the certificate bundles + to be listed. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -1847,6 +2288,14 @@ def list_certificates(self, load_balancer_id, **kwargs): The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.Certificate` :rtype: :class:`~oci.response.Response` """ @@ -1900,6 +2349,83 @@ def list_certificates(self, load_balancer_id, **kwargs): header_params=header_params, response_type="list[Certificate]") + def list_hostnames(self, load_balancer_id, **kwargs): + """ + ListHostnames + Lists all hostname resources associated with the specified load balancer. + + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer associated with the hostnames + to retrieve. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.Hostname` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/loadBalancers/{loadBalancerId}/hostnames" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_hostnames got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "loadBalancerId": load_balancer_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="list[Hostname]") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="list[Hostname]") + def list_load_balancer_healths(self, compartment_id, **kwargs): """ ListLoadBalancerHealths @@ -1925,6 +2451,14 @@ def list_load_balancer_healths(self, compartment_id, **kwargs): Example: `3` + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancerHealthSummary` :rtype: :class:`~oci.response.Response` """ @@ -2021,11 +2555,23 @@ def list_load_balancers(self, compartment_id, **kwargs): :param str display_name: (optional) A filter to return only resources that match the given display name exactly. + Example: `example_load_balancer` + :param str lifecycle_state: (optional) A filter to return only resources that match the given lifecycle state. + Example: `SUCCEEDED` + Allowed values are: "CREATING", "FAILED", "ACTIVE", "DELETING", "DELETED" + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancer` :rtype: :class:`~oci.response.Response` """ @@ -2125,6 +2671,14 @@ def list_path_route_sets(self, load_balancer_id, **kwargs): The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.PathRouteSet` :rtype: :class:`~oci.response.Response` """ @@ -2203,6 +2757,14 @@ def list_policies(self, compartment_id, **kwargs): Example: `3` + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancerPolicy` :rtype: :class:`~oci.response.Response` """ @@ -2280,6 +2842,14 @@ def list_protocols(self, compartment_id, **kwargs): Example: `3` + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancerProtocol` :rtype: :class:`~oci.response.Response` """ @@ -2357,6 +2927,14 @@ def list_shapes(self, compartment_id, **kwargs): Example: `3` + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancerShape` :rtype: :class:`~oci.response.Response` """ @@ -2434,6 +3012,14 @@ def list_work_requests(self, load_balancer_id, **kwargs): Example: `3` + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.WorkRequest` :rtype: :class:`~oci.response.Response` """ @@ -2514,12 +3100,12 @@ def update_backend(self, update_backend_details, load_balancer_id, backend_set_n :param str backend_set_name: (required) The name of the backend set associated with the backend server. - Example: `My_backend_set` + Example: `example_backend_set` :param str backend_name: (required) The IP address and port of the backend server to update. - Example: `1.1.1.7:42` + Example: `10.0.0.3:8080` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -2532,6 +3118,14 @@ def update_backend(self, update_backend_details, load_balancer_id, backend_set_n has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2608,7 +3202,7 @@ def update_backend_set(self, update_backend_set_details, load_balancer_id, backe :param str backend_set_name: (required) The name of the backend set to update. - Example: `My_backend_set` + Example: `example_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -2621,6 +3215,14 @@ def update_backend_set(self, update_backend_set_details, load_balancer_id, backe has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2696,7 +3298,7 @@ def update_health_checker(self, health_checker, load_balancer_id, backend_set_na :param str backend_set_name: (required) The name of the backend set associated with the health check policy to be retrieved. - Example: `My_backend_set` + Example: `example_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -2709,6 +3311,14 @@ def update_health_checker(self, health_checker, load_balancer_id, backend_set_na has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2767,6 +3377,93 @@ def update_health_checker(self, health_checker, load_balancer_id, backend_set_na header_params=header_params, body=health_checker) + def update_hostname(self, update_hostname_details, load_balancer_id, name, **kwargs): + """ + UpdateHostname + Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a + virtual hostname. + + + :param UpdateHostnameDetails update_hostname_details: (required) + The configuration details to update a virtual hostname. + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer associated with the virtual hostname + to update. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :param str name: (required) + The name of the hostname resource to update. + + Example: `example_hostname_001` + + :param str opc_request_id: (optional) + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/loadBalancers/{loadBalancerId}/hostnames/{name}" + method = "PUT" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_hostname got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "loadBalancerId": load_balancer_id, + "name": name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_hostname_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_hostname_details) + def update_listener(self, update_listener_details, load_balancer_id, listener_name, **kwargs): """ UpdateListener @@ -2784,7 +3481,7 @@ def update_listener(self, update_listener_details, load_balancer_id, listener_na :param str listener_name: (required) The name of the listener to update. - Example: `My listener` + Example: `example_listener` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -2797,6 +3494,14 @@ def update_listener(self, update_listener_details, load_balancer_id, listener_na has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2880,6 +3585,14 @@ def update_load_balancer(self, update_load_balancer_details, load_balancer_id, * has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2959,7 +3672,7 @@ def update_path_route_set(self, update_path_route_set_details, load_balancer_id, :param str path_route_set_name: (required) The name of the path route set to update. - Example: `path-route-set-001` + Example: `example_path_route_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -2972,6 +3685,14 @@ def update_path_route_set(self, update_path_route_set_details, load_balancer_id, has been deleted and purged from the system, then a retry of the original creation request may be rejected). + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/load_balancer/load_balancer_client_composite_operations.py b/src/oci/load_balancer/load_balancer_client_composite_operations.py index c8aff19a01..d4274ba7cc 100644 --- a/src/oci/load_balancer/load_balancer_client_composite_operations.py +++ b/src/oci/load_balancer/load_balancer_client_composite_operations.py @@ -37,7 +37,7 @@ def create_backend_and_wait_for_state(self, create_backend_details, load_balance :param str backend_set_name: (required) The name of the backend set to add the backend server to. - Example: `My_backend_set` + Example: `example_backend_set` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -118,10 +118,10 @@ def create_certificate_and_wait_for_state(self, create_certificate_details, load to enter the given state(s). :param CreateCertificateDetails create_certificate_details: (required) - The details of the certificate to add. + The details of the certificate bundle to add. :param str load_balancer_id: (required) - The `OCID`__ of the load balancer on which to add the certificate. + The `OCID`__ of the load balancer on which to add the certificate bundle. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -155,6 +155,49 @@ def create_certificate_and_wait_for_state(self, create_certificate_details, load except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_hostname_and_wait_for_state(self, create_hostname_details, load_balancer_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.load_balancer.LoadBalancerClient.create_hostname` and waits for the :py:class:`~oci.load_balancer.models.WorkRequest` + to enter the given state(s). + + :param CreateHostnameDetails create_hostname_details: (required) + The details of the hostname resource to add to the specified load balancer. + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer to add the hostname to. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.load_balancer.LoadBalancerClient.create_hostname` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_hostname(create_hostname_details, load_balancer_id, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_listener_and_wait_for_state(self, create_listener_details, load_balancer_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.load_balancer.LoadBalancerClient.create_listener` and waits for the :py:class:`~oci.load_balancer.models.WorkRequest` @@ -292,12 +335,12 @@ def delete_backend_and_wait_for_state(self, load_balancer_id, backend_set_name, :param str backend_set_name: (required) The name of the backend set associated with the backend server. - Example: `My_backend_set` + Example: `example_backend_set` :param str backend_name: (required) The IP address and port of the backend server to remove. - Example: `1.1.1.7:42` + Example: `10.0.0.3:8080` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -342,7 +385,7 @@ def delete_backend_set_and_wait_for_state(self, load_balancer_id, backend_set_na :param str backend_set_name: (required) The name of the backend set to delete. - Example: `My_backend_set` + Example: `example_backend_set` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -380,14 +423,15 @@ def delete_certificate_and_wait_for_state(self, load_balancer_id, certificate_na to enter the given state(s). :param str load_balancer_id: (required) - The `OCID`__ of the load balancer associated with the certificate to be deleted. + The `OCID`__ of the load balancer associated with the certificate bundle + to be deleted. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str certificate_name: (required) - The name of the certificate to delete. + The name of the certificate bundle to delete. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -419,6 +463,51 @@ def delete_certificate_and_wait_for_state(self, load_balancer_id, certificate_na except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_hostname_and_wait_for_state(self, load_balancer_id, name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.load_balancer.LoadBalancerClient.delete_hostname` and waits for the :py:class:`~oci.load_balancer.models.WorkRequest` + to enter the given state(s). + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer associated with the hostname to delete. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :param str name: (required) + The name of the hostname resource to delete. + + Example: `example_hostname_001` + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.load_balancer.LoadBalancerClient.delete_hostname` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.delete_hostname(load_balancer_id, name, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_listener_and_wait_for_state(self, load_balancer_id, listener_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.load_balancer.LoadBalancerClient.delete_listener` and waits for the :py:class:`~oci.load_balancer.models.WorkRequest` @@ -432,7 +521,7 @@ def delete_listener_and_wait_for_state(self, load_balancer_id, listener_name, wa :param str listener_name: (required) The name of the listener to delete. - Example: `My listener` + Example: `example_listener` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -517,7 +606,7 @@ def delete_path_route_set_and_wait_for_state(self, load_balancer_id, path_route_ :param str path_route_set_name: (required) The name of the path route set to delete. - Example: `path-route-set-001` + Example: `example_path_route_set` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -565,12 +654,12 @@ def update_backend_and_wait_for_state(self, update_backend_details, load_balance :param str backend_set_name: (required) The name of the backend set associated with the backend server. - Example: `My_backend_set` + Example: `example_backend_set` :param str backend_name: (required) The IP address and port of the backend server to update. - Example: `1.1.1.7:42` + Example: `10.0.0.3:8080` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -618,7 +707,7 @@ def update_backend_set_and_wait_for_state(self, update_backend_set_details, load :param str backend_set_name: (required) The name of the backend set to update. - Example: `My_backend_set` + Example: `example_backend_set` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -666,7 +755,7 @@ def update_health_checker_and_wait_for_state(self, health_checker, load_balancer :param str backend_set_name: (required) The name of the backend set associated with the health check policy to be retrieved. - Example: `My_backend_set` + Example: `example_backend_set` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -698,6 +787,55 @@ def update_health_checker_and_wait_for_state(self, health_checker, load_balancer except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_hostname_and_wait_for_state(self, update_hostname_details, load_balancer_id, name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.load_balancer.LoadBalancerClient.update_hostname` and waits for the :py:class:`~oci.load_balancer.models.WorkRequest` + to enter the given state(s). + + :param UpdateHostnameDetails update_hostname_details: (required) + The configuration details to update a virtual hostname. + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer associated with the virtual hostname + to update. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :param str name: (required) + The name of the hostname resource to update. + + Example: `example_hostname_001` + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.load_balancer.LoadBalancerClient.update_hostname` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_hostname(update_hostname_details, load_balancer_id, name, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_listener_and_wait_for_state(self, update_listener_details, load_balancer_id, listener_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.load_balancer.LoadBalancerClient.update_listener` and waits for the :py:class:`~oci.load_balancer.models.WorkRequest` @@ -714,7 +852,7 @@ def update_listener_and_wait_for_state(self, update_listener_details, load_balan :param str listener_name: (required) The name of the listener to update. - Example: `My listener` + Example: `example_listener` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` @@ -805,7 +943,7 @@ def update_path_route_set_and_wait_for_state(self, update_path_route_set_details :param str path_route_set_name: (required) The name of the path route set to update. - Example: `path-route-set-001` + Example: `example_path_route_set` :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.load_balancer.models.WorkRequest.lifecycle_state` diff --git a/src/oci/load_balancer/models/__init__.py b/src/oci/load_balancer/models/__init__.py index 1d6002e0b1..7e8689b1fd 100644 --- a/src/oci/load_balancer/models/__init__.py +++ b/src/oci/load_balancer/models/__init__.py @@ -15,12 +15,15 @@ from .create_backend_details import CreateBackendDetails from .create_backend_set_details import CreateBackendSetDetails from .create_certificate_details import CreateCertificateDetails +from .create_hostname_details import CreateHostnameDetails from .create_listener_details import CreateListenerDetails from .create_load_balancer_details import CreateLoadBalancerDetails from .create_path_route_set_details import CreatePathRouteSetDetails from .health_check_result import HealthCheckResult from .health_checker import HealthChecker from .health_checker_details import HealthCheckerDetails +from .hostname import Hostname +from .hostname_details import HostnameDetails from .ip_address import IpAddress from .listener import Listener from .listener_details import ListenerDetails @@ -40,6 +43,7 @@ from .update_backend_details import UpdateBackendDetails from .update_backend_set_details import UpdateBackendSetDetails from .update_health_checker_details import UpdateHealthCheckerDetails +from .update_hostname_details import UpdateHostnameDetails from .update_listener_details import UpdateListenerDetails from .update_load_balancer_details import UpdateLoadBalancerDetails from .update_path_route_set_details import UpdatePathRouteSetDetails @@ -60,12 +64,15 @@ "CreateBackendDetails": CreateBackendDetails, "CreateBackendSetDetails": CreateBackendSetDetails, "CreateCertificateDetails": CreateCertificateDetails, + "CreateHostnameDetails": CreateHostnameDetails, "CreateListenerDetails": CreateListenerDetails, "CreateLoadBalancerDetails": CreateLoadBalancerDetails, "CreatePathRouteSetDetails": CreatePathRouteSetDetails, "HealthCheckResult": HealthCheckResult, "HealthChecker": HealthChecker, "HealthCheckerDetails": HealthCheckerDetails, + "Hostname": Hostname, + "HostnameDetails": HostnameDetails, "IpAddress": IpAddress, "Listener": Listener, "ListenerDetails": ListenerDetails, @@ -85,6 +92,7 @@ "UpdateBackendDetails": UpdateBackendDetails, "UpdateBackendSetDetails": UpdateBackendSetDetails, "UpdateHealthCheckerDetails": UpdateHealthCheckerDetails, + "UpdateHostnameDetails": UpdateHostnameDetails, "UpdateListenerDetails": UpdateListenerDetails, "UpdateLoadBalancerDetails": UpdateLoadBalancerDetails, "UpdatePathRouteSetDetails": UpdatePathRouteSetDetails, diff --git a/src/oci/load_balancer/models/backend.py b/src/oci/load_balancer/models/backend.py index 83a8ba755d..25ff416222 100644 --- a/src/oci/load_balancer/models/backend.py +++ b/src/oci/load_balancer/models/backend.py @@ -84,7 +84,7 @@ def backup(self): Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy. - Example: `true` + Example: `false` :return: The backup of this Backend. @@ -99,7 +99,7 @@ def backup(self, backup): Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy. - Example: `true` + Example: `false` :param backup: The backup of this Backend. @@ -114,7 +114,7 @@ def drain(self): Whether the load balancer should drain this server. Servers marked \"drain\" receive no new incoming traffic. - Example: `true` + Example: `false` :return: The drain of this Backend. @@ -129,7 +129,7 @@ def drain(self, drain): Whether the load balancer should drain this server. Servers marked \"drain\" receive no new incoming traffic. - Example: `true` + Example: `false` :param drain: The drain of this Backend. @@ -143,7 +143,7 @@ def ip_address(self): **[Required]** Gets the ip_address of this Backend. The IP address of the backend server. - Example: `10.10.10.4` + Example: `10.0.0.3` :return: The ip_address of this Backend. @@ -157,7 +157,7 @@ def ip_address(self, ip_address): Sets the ip_address of this Backend. The IP address of the backend server. - Example: `10.10.10.4` + Example: `10.0.0.3` :param ip_address: The ip_address of this Backend. @@ -171,7 +171,7 @@ def name(self): **[Required]** Gets the name of this Backend. A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. - Example: `10.10.10.4:8080` + Example: `10.0.0.3:8080` :return: The name of this Backend. @@ -185,7 +185,7 @@ def name(self, name): Sets the name of this Backend. A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. - Example: `10.10.10.4:8080` + Example: `10.0.0.3:8080` :param name: The name of this Backend. @@ -200,7 +200,7 @@ def offline(self): Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. - Example: `true` + Example: `false` :return: The offline of this Backend. @@ -215,7 +215,7 @@ def offline(self, offline): Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. - Example: `true` + Example: `false` :param offline: The offline of this Backend. diff --git a/src/oci/load_balancer/models/backend_details.py b/src/oci/load_balancer/models/backend_details.py index e00fed8b69..863a5edb3a 100644 --- a/src/oci/load_balancer/models/backend_details.py +++ b/src/oci/load_balancer/models/backend_details.py @@ -74,7 +74,7 @@ def backup(self): Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy. - Example: `true` + Example: `false` :return: The backup of this BackendDetails. @@ -89,7 +89,7 @@ def backup(self, backup): Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy. - Example: `true` + Example: `false` :param backup: The backup of this BackendDetails. @@ -104,7 +104,7 @@ def drain(self): Whether the load balancer should drain this server. Servers marked \"drain\" receive no new incoming traffic. - Example: `true` + Example: `false` :return: The drain of this BackendDetails. @@ -119,7 +119,7 @@ def drain(self, drain): Whether the load balancer should drain this server. Servers marked \"drain\" receive no new incoming traffic. - Example: `true` + Example: `false` :param drain: The drain of this BackendDetails. @@ -133,7 +133,7 @@ def ip_address(self): **[Required]** Gets the ip_address of this BackendDetails. The IP address of the backend server. - Example: `10.10.10.4` + Example: `10.0.0.3` :return: The ip_address of this BackendDetails. @@ -147,7 +147,7 @@ def ip_address(self, ip_address): Sets the ip_address of this BackendDetails. The IP address of the backend server. - Example: `10.10.10.4` + Example: `10.0.0.3` :param ip_address: The ip_address of this BackendDetails. @@ -162,7 +162,7 @@ def offline(self): Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. - Example: `true` + Example: `false` :return: The offline of this BackendDetails. @@ -177,7 +177,7 @@ def offline(self, offline): Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. - Example: `true` + Example: `false` :param offline: The offline of this BackendDetails. diff --git a/src/oci/load_balancer/models/backend_set.py b/src/oci/load_balancer/models/backend_set.py index 1ab9d67675..90af381e20 100644 --- a/src/oci/load_balancer/models/backend_set.py +++ b/src/oci/load_balancer/models/backend_set.py @@ -120,7 +120,7 @@ def name(self): Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. - Example: `My_backend_set` + Example: `example_backend_set` :return: The name of this BackendSet. @@ -137,7 +137,7 @@ def name(self, name): Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. - Example: `My_backend_set` + Example: `example_backend_set` :param name: The name of this BackendSet. diff --git a/src/oci/load_balancer/models/backend_set_health.py b/src/oci/load_balancer/models/backend_set_health.py index 412d92a930..ae7349f00e 100644 --- a/src/oci/load_balancer/models/backend_set_health.py +++ b/src/oci/load_balancer/models/backend_set_health.py @@ -88,7 +88,7 @@ def critical_state_backend_names(self): A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by IP address and port. - Example: `1.1.1.1:80` + Example: `10.0.0.4:8080` :return: The critical_state_backend_names of this BackendSetHealth. @@ -103,7 +103,7 @@ def critical_state_backend_names(self, critical_state_backend_names): A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by IP address and port. - Example: `1.1.1.1:80` + Example: `10.0.0.4:8080` :param critical_state_backend_names: The critical_state_backend_names of this BackendSetHealth. @@ -167,7 +167,7 @@ def total_backend_count(self): **[Required]** Gets the total_backend_count of this BackendSetHealth. The total number of backend servers in this backend set. - Example: `5` + Example: `7` :return: The total_backend_count of this BackendSetHealth. @@ -181,7 +181,7 @@ def total_backend_count(self, total_backend_count): Sets the total_backend_count of this BackendSetHealth. The total number of backend servers in this backend set. - Example: `5` + Example: `7` :param total_backend_count: The total_backend_count of this BackendSetHealth. @@ -196,7 +196,7 @@ def unknown_state_backend_names(self): A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by IP address and port. - Example: `1.1.1.5:80` + Example: `10.0.0.5:8080` :return: The unknown_state_backend_names of this BackendSetHealth. @@ -211,7 +211,7 @@ def unknown_state_backend_names(self, unknown_state_backend_names): A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by IP address and port. - Example: `1.1.1.5:80` + Example: `10.0.0.5:8080` :param unknown_state_backend_names: The unknown_state_backend_names of this BackendSetHealth. @@ -226,7 +226,7 @@ def warning_state_backend_names(self): A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by IP address and port. - Example: `1.1.1.7:42` + Example: `10.0.0.3:8080` :return: The warning_state_backend_names of this BackendSetHealth. @@ -241,7 +241,7 @@ def warning_state_backend_names(self, warning_state_backend_names): A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by IP address and port. - Example: `1.1.1.7:42` + Example: `10.0.0.3:8080` :param warning_state_backend_names: The warning_state_backend_names of this BackendSetHealth. diff --git a/src/oci/load_balancer/models/certificate.py b/src/oci/load_balancer/models/certificate.py index c75c2195dc..f049435eb8 100644 --- a/src/oci/load_balancer/models/certificate.py +++ b/src/oci/load_balancer/models/certificate.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class Certificate(object): """ - The configuration details of a listener certificate bundle. + The configuration details of a certificate bundle. For more information on SSL certficate configuration, see `Managing SSL Certificates`__. @@ -102,7 +102,7 @@ def certificate_name(self): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :return: The certificate_name of this Certificate. @@ -118,7 +118,7 @@ def certificate_name(self, certificate_name): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :param certificate_name: The certificate_name of this Certificate. diff --git a/src/oci/load_balancer/models/certificate_details.py b/src/oci/load_balancer/models/certificate_details.py index 73a1d416d9..01e482d98d 100644 --- a/src/oci/load_balancer/models/certificate_details.py +++ b/src/oci/load_balancer/models/certificate_details.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class CertificateDetails(object): """ - The configuration details for a listener certificate bundle. + The configuration details for a certificate bundle. For more information on SSL certficate configuration, see `Managing SSL Certificates`__. @@ -116,7 +116,7 @@ def certificate_name(self): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :return: The certificate_name of this CertificateDetails. @@ -132,7 +132,7 @@ def certificate_name(self, certificate_name): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :param certificate_name: The certificate_name of this CertificateDetails. @@ -146,8 +146,6 @@ def passphrase(self): Gets the passphrase of this CertificateDetails. A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase. - Example: `Mysecretunlockingcode42!1!` - :return: The passphrase of this CertificateDetails. :rtype: str @@ -160,8 +158,6 @@ def passphrase(self, passphrase): Sets the passphrase of this CertificateDetails. A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase. - Example: `Mysecretunlockingcode42!1!` - :param passphrase: The passphrase of this CertificateDetails. :type: str diff --git a/src/oci/load_balancer/models/connection_configuration.py b/src/oci/load_balancer/models/connection_configuration.py index 02765bca17..8e8e100308 100644 --- a/src/oci/load_balancer/models/connection_configuration.py +++ b/src/oci/load_balancer/models/connection_configuration.py @@ -40,38 +40,11 @@ def idle_timeout(self): between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations. - The default values are: - - * 300 seconds for TCP - - * 60 seconds for HTTP and WebSocket protocols. - - Note: The protocol is set at the listener. - - Modify this parameter if the client or backend server stops transmitting data for more than the default time. - Some examples include: - - * The client sends a database query to the backend server and the database takes over 300 seconds to execute. - Therefore, the backend server does not transmit any data within 300 seconds. - - * The client uploads data using the HTTP protocol. During the upload, the backend does not transmit any data - to the client for more than 60 seconds. - - * The client downloads data using the HTTP protocol. After the initial request, it stops transmitting data to - the backend server for more than 60 seconds. - - * The client starts transmitting data after establishing a WebSocket connection, but the backend server does - not transmit data for more than 60 seconds. - - * The backend server starts transmitting data after establishing a WebSocket connection, but the client does - not transmit data for more than 60 seconds. - - The maximum value is 7200 seconds. Contact My Oracle Support to file a service request if you want to increase - this limit for your tenancy. For more information, see `Service Limits`__. + For more information, see `Connection Configuration`__. Example: `1200` - __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/connectionreuse.htm#ConnectionConfiguration :return: The idle_timeout of this ConnectionConfiguration. @@ -87,38 +60,11 @@ def idle_timeout(self, idle_timeout): between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations. - The default values are: - - * 300 seconds for TCP - - * 60 seconds for HTTP and WebSocket protocols. - - Note: The protocol is set at the listener. - - Modify this parameter if the client or backend server stops transmitting data for more than the default time. - Some examples include: - - * The client sends a database query to the backend server and the database takes over 300 seconds to execute. - Therefore, the backend server does not transmit any data within 300 seconds. - - * The client uploads data using the HTTP protocol. During the upload, the backend does not transmit any data - to the client for more than 60 seconds. - - * The client downloads data using the HTTP protocol. After the initial request, it stops transmitting data to - the backend server for more than 60 seconds. - - * The client starts transmitting data after establishing a WebSocket connection, but the backend server does - not transmit data for more than 60 seconds. - - * The backend server starts transmitting data after establishing a WebSocket connection, but the client does - not transmit data for more than 60 seconds. - - The maximum value is 7200 seconds. Contact My Oracle Support to file a service request if you want to increase - this limit for your tenancy. For more information, see `Service Limits`__. + For more information, see `Connection Configuration`__. Example: `1200` - __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/connectionreuse.htm#ConnectionConfiguration :param idle_timeout: The idle_timeout of this ConnectionConfiguration. diff --git a/src/oci/load_balancer/models/create_backend_details.py b/src/oci/load_balancer/models/create_backend_details.py index 7aabe2b09d..af56807ff1 100644 --- a/src/oci/load_balancer/models/create_backend_details.py +++ b/src/oci/load_balancer/models/create_backend_details.py @@ -78,7 +78,7 @@ def backup(self): Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy. - Example: `true` + Example: `false` :return: The backup of this CreateBackendDetails. @@ -93,7 +93,7 @@ def backup(self, backup): Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy. - Example: `true` + Example: `false` :param backup: The backup of this CreateBackendDetails. @@ -108,7 +108,7 @@ def drain(self): Whether the load balancer should drain this server. Servers marked \"drain\" receive no new incoming traffic. - Example: `true` + Example: `false` :return: The drain of this CreateBackendDetails. @@ -123,7 +123,7 @@ def drain(self, drain): Whether the load balancer should drain this server. Servers marked \"drain\" receive no new incoming traffic. - Example: `true` + Example: `false` :param drain: The drain of this CreateBackendDetails. @@ -137,7 +137,7 @@ def ip_address(self): **[Required]** Gets the ip_address of this CreateBackendDetails. The IP address of the backend server. - Example: `10.10.10.4` + Example: `10.0.0.3` :return: The ip_address of this CreateBackendDetails. @@ -151,7 +151,7 @@ def ip_address(self, ip_address): Sets the ip_address of this CreateBackendDetails. The IP address of the backend server. - Example: `10.10.10.4` + Example: `10.0.0.3` :param ip_address: The ip_address of this CreateBackendDetails. @@ -166,7 +166,7 @@ def offline(self): Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. - Example: `true` + Example: `false` :return: The offline of this CreateBackendDetails. @@ -181,7 +181,7 @@ def offline(self, offline): Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. - Example: `true` + Example: `false` :param offline: The offline of this CreateBackendDetails. diff --git a/src/oci/load_balancer/models/create_backend_set_details.py b/src/oci/load_balancer/models/create_backend_set_details.py index dc75148ee9..3a5d1b7527 100644 --- a/src/oci/load_balancer/models/create_backend_set_details.py +++ b/src/oci/load_balancer/models/create_backend_set_details.py @@ -120,7 +120,7 @@ def name(self): Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. - Example: `My_backend_set` + Example: `example_backend_set` :return: The name of this CreateBackendSetDetails. @@ -137,7 +137,7 @@ def name(self, name): Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. - Example: `My_backend_set` + Example: `example_backend_set` :param name: The name of this CreateBackendSetDetails. diff --git a/src/oci/load_balancer/models/create_certificate_details.py b/src/oci/load_balancer/models/create_certificate_details.py index 5996923be2..5219a40656 100644 --- a/src/oci/load_balancer/models/create_certificate_details.py +++ b/src/oci/load_balancer/models/create_certificate_details.py @@ -116,7 +116,7 @@ def certificate_name(self): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :return: The certificate_name of this CreateCertificateDetails. @@ -132,7 +132,7 @@ def certificate_name(self, certificate_name): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :param certificate_name: The certificate_name of this CreateCertificateDetails. @@ -146,8 +146,6 @@ def passphrase(self): Gets the passphrase of this CreateCertificateDetails. A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase. - Example: `Mysecretunlockingcode42!1!` - :return: The passphrase of this CreateCertificateDetails. :rtype: str @@ -160,8 +158,6 @@ def passphrase(self, passphrase): Sets the passphrase of this CreateCertificateDetails. A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase. - Example: `Mysecretunlockingcode42!1!` - :param passphrase: The passphrase of this CreateCertificateDetails. :type: str @@ -221,10 +217,10 @@ def public_certificate(self): Example: -----BEGIN CERTIFICATE----- - MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG - A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE - MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl - YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw + MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbM..QswCQYDVQQGEwJKU + A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxE..TAPBgNVBAoTCEZyY + MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWB..gNVBAMTD0ZyYW5rN + YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmc..mFuazRkZC5jb20wH ... -----END CERTIFICATE----- @@ -243,10 +239,10 @@ def public_certificate(self, public_certificate): Example: -----BEGIN CERTIFICATE----- - MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG - A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE - MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl - YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw + MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbM..QswCQYDVQQGEwJKU + A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxE..TAPBgNVBAoTCEZyY + MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWB..gNVBAMTD0ZyYW5rN + YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmc..mFuazRkZC5jb20wH ... -----END CERTIFICATE----- diff --git a/src/oci/load_balancer/models/create_hostname_details.py b/src/oci/load_balancer/models/create_hostname_details.py new file mode 100644 index 0000000000..fb7217cdbb --- /dev/null +++ b/src/oci/load_balancer/models/create_hostname_details.py @@ -0,0 +1,116 @@ +# coding: utf-8 +# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateHostnameDetails(object): + """ + The details of the hostname resource to add to a load balancer. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateHostnameDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param hostname: + The value to assign to the hostname property of this CreateHostnameDetails. + :type hostname: str + + :param name: + The value to assign to the name property of this CreateHostnameDetails. + :type name: str + + """ + self.swagger_types = { + 'hostname': 'str', + 'name': 'str' + } + + self.attribute_map = { + 'hostname': 'hostname', + 'name': 'name' + } + + self._hostname = None + self._name = None + + @property + def hostname(self): + """ + **[Required]** Gets the hostname of this CreateHostnameDetails. + A virtual hostname. For more information about virtual hostname string construction, see + `Managing Request Routing`__. + + Example: `app.example.com` + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm#routing + + + :return: The hostname of this CreateHostnameDetails. + :rtype: str + """ + return self._hostname + + @hostname.setter + def hostname(self, hostname): + """ + Sets the hostname of this CreateHostnameDetails. + A virtual hostname. For more information about virtual hostname string construction, see + `Managing Request Routing`__. + + Example: `app.example.com` + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm#routing + + + :param hostname: The hostname of this CreateHostnameDetails. + :type: str + """ + self._hostname = hostname + + @property + def name(self): + """ + **[Required]** Gets the name of this CreateHostnameDetails. + A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential + information. + + Example: `example_hostname_001` + + + :return: The name of this CreateHostnameDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateHostnameDetails. + A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential + information. + + Example: `example_hostname_001` + + + :param name: The name of this CreateHostnameDetails. + :type: str + """ + self._name = name + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/load_balancer/models/create_listener_details.py b/src/oci/load_balancer/models/create_listener_details.py index c00480d1f1..c1b5fdbca7 100644 --- a/src/oci/load_balancer/models/create_listener_details.py +++ b/src/oci/load_balancer/models/create_listener_details.py @@ -13,7 +13,7 @@ class CreateListenerDetails(object): For more information on listener configuration, see `Managing Load Balancer Listeners`__. - __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managinglisteners.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managinglisteners.htm """ def __init__(self, **kwargs): @@ -29,6 +29,10 @@ def __init__(self, **kwargs): The value to assign to the default_backend_set_name property of this CreateListenerDetails. :type default_backend_set_name: str + :param hostname_names: + The value to assign to the hostname_names property of this CreateListenerDetails. + :type hostname_names: list[str] + :param name: The value to assign to the name property of this CreateListenerDetails. :type name: str @@ -53,6 +57,7 @@ def __init__(self, **kwargs): self.swagger_types = { 'connection_configuration': 'ConnectionConfiguration', 'default_backend_set_name': 'str', + 'hostname_names': 'list[str]', 'name': 'str', 'path_route_set_name': 'str', 'port': 'int', @@ -63,6 +68,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'connection_configuration': 'connectionConfiguration', 'default_backend_set_name': 'defaultBackendSetName', + 'hostname_names': 'hostnameNames', 'name': 'name', 'path_route_set_name': 'pathRouteSetName', 'port': 'port', @@ -72,6 +78,7 @@ def __init__(self, **kwargs): self._connection_configuration = None self._default_backend_set_name = None + self._hostname_names = None self._name = None self._path_route_set_name = None self._port = None @@ -104,7 +111,7 @@ def default_backend_set_name(self): **[Required]** Gets the default_backend_set_name of this CreateListenerDetails. The name of the associated backend set. - Example: `My_backend_set` + Example: `example_backend_set` :return: The default_backend_set_name of this CreateListenerDetails. @@ -118,7 +125,7 @@ def default_backend_set_name(self, default_backend_set_name): Sets the default_backend_set_name of this CreateListenerDetails. The name of the associated backend set. - Example: `My_backend_set` + Example: `example_backend_set` :param default_backend_set_name: The default_backend_set_name of this CreateListenerDetails. @@ -126,6 +133,30 @@ def default_backend_set_name(self, default_backend_set_name): """ self._default_backend_set_name = default_backend_set_name + @property + def hostname_names(self): + """ + Gets the hostname_names of this CreateListenerDetails. + An array of hostname resource names. + + + :return: The hostname_names of this CreateListenerDetails. + :rtype: list[str] + """ + return self._hostname_names + + @hostname_names.setter + def hostname_names(self, hostname_names): + """ + Sets the hostname_names of this CreateListenerDetails. + An array of hostname resource names. + + + :param hostname_names: The hostname_names of this CreateListenerDetails. + :type: list[str] + """ + self._hostname_names = hostname_names + @property def name(self): """ @@ -133,7 +164,7 @@ def name(self): A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. - Example: `My listener` + Example: `example_listener` :return: The name of this CreateListenerDetails. @@ -148,7 +179,7 @@ def name(self, name): A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. - Example: `My listener` + Example: `example_listener` :param name: The name of this CreateListenerDetails. @@ -163,7 +194,7 @@ def path_route_set_name(self): The name of the set of path-based routing rules, :class:`PathRouteSet`, applied to this listener's traffic. - Example: `path-route-set-001` + Example: `example_path_route_set` :return: The path_route_set_name of this CreateListenerDetails. @@ -178,7 +209,7 @@ def path_route_set_name(self, path_route_set_name): The name of the set of path-based routing rules, :class:`PathRouteSet`, applied to this listener's traffic. - Example: `path-route-set-001` + Example: `example_path_route_set` :param path_route_set_name: The path_route_set_name of this CreateListenerDetails. diff --git a/src/oci/load_balancer/models/create_load_balancer_details.py b/src/oci/load_balancer/models/create_load_balancer_details.py index eb6f0df72e..52649a743b 100644 --- a/src/oci/load_balancer/models/create_load_balancer_details.py +++ b/src/oci/load_balancer/models/create_load_balancer_details.py @@ -33,6 +33,10 @@ def __init__(self, **kwargs): The value to assign to the display_name property of this CreateLoadBalancerDetails. :type display_name: str + :param hostnames: + The value to assign to the hostnames property of this CreateLoadBalancerDetails. + :type hostnames: dict(str, HostnameDetails) + :param is_private: The value to assign to the is_private property of this CreateLoadBalancerDetails. :type is_private: bool @@ -59,6 +63,7 @@ def __init__(self, **kwargs): 'certificates': 'dict(str, CertificateDetails)', 'compartment_id': 'str', 'display_name': 'str', + 'hostnames': 'dict(str, HostnameDetails)', 'is_private': 'bool', 'listeners': 'dict(str, ListenerDetails)', 'path_route_sets': 'dict(str, PathRouteSetDetails)', @@ -71,6 +76,7 @@ def __init__(self, **kwargs): 'certificates': 'certificates', 'compartment_id': 'compartmentId', 'display_name': 'displayName', + 'hostnames': 'hostnames', 'is_private': 'isPrivate', 'listeners': 'listeners', 'path_route_sets': 'pathRouteSets', @@ -82,6 +88,7 @@ def __init__(self, **kwargs): self._certificates = None self._compartment_id = None self._display_name = None + self._hostnames = None self._is_private = None self._listeners = None self._path_route_sets = None @@ -163,7 +170,7 @@ def display_name(self): A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. - Example: `My load balancer` + Example: `example_load_balancer` :return: The display_name of this CreateLoadBalancerDetails. @@ -178,7 +185,7 @@ def display_name(self, display_name): A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. - Example: `My load balancer` + Example: `example_load_balancer` :param display_name: The display_name of this CreateLoadBalancerDetails. @@ -186,6 +193,26 @@ def display_name(self, display_name): """ self._display_name = display_name + @property + def hostnames(self): + """ + Gets the hostnames of this CreateLoadBalancerDetails. + + :return: The hostnames of this CreateLoadBalancerDetails. + :rtype: dict(str, HostnameDetails) + """ + return self._hostnames + + @hostnames.setter + def hostnames(self, hostnames): + """ + Sets the hostnames of this CreateLoadBalancerDetails. + + :param hostnames: The hostnames of this CreateLoadBalancerDetails. + :type: dict(str, HostnameDetails) + """ + self._hostnames = hostnames + @property def is_private(self): """ @@ -204,7 +231,7 @@ def is_private(self): hosts the secondary (standby) load balancer. A public load balancer is accessible from the internet, depending on your VCN's `security list rules`__. - Example: `false` + Example: `true` __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm @@ -232,7 +259,7 @@ def is_private(self, is_private): hosts the secondary (standby) load balancer. A public load balancer is accessible from the internet, depending on your VCN's `security list rules`__. - Example: `false` + Example: `true` __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm diff --git a/src/oci/load_balancer/models/create_path_route_set_details.py b/src/oci/load_balancer/models/create_path_route_set_details.py index 3f5be94338..52c2fe5b77 100644 --- a/src/oci/load_balancer/models/create_path_route_set_details.py +++ b/src/oci/load_balancer/models/create_path_route_set_details.py @@ -46,7 +46,7 @@ def name(self): The name for this set of path route rules. It must be unique and it cannot be changed. Avoid entering confidential information. - Example: `path-route-set-001` + Example: `example_path_route_set` :return: The name of this CreatePathRouteSetDetails. @@ -61,7 +61,7 @@ def name(self, name): The name for this set of path route rules. It must be unique and it cannot be changed. Avoid entering confidential information. - Example: `path-route-set-001` + Example: `example_path_route_set` :param name: The name of this CreatePathRouteSetDetails. diff --git a/src/oci/load_balancer/models/health_check_result.py b/src/oci/load_balancer/models/health_check_result.py index ee5f0a5d9e..a0275890c9 100644 --- a/src/oci/load_balancer/models/health_check_result.py +++ b/src/oci/load_balancer/models/health_check_result.py @@ -124,7 +124,7 @@ def source_ip_address(self): The IP address of the health check status report provider. This identifier helps you differentiate same-subnet (private) load balancers that report health check status. - Example: `10.2.0.1` + Example: `10.0.0.7` :return: The source_ip_address of this HealthCheckResult. @@ -139,7 +139,7 @@ def source_ip_address(self, source_ip_address): The IP address of the health check status report provider. This identifier helps you differentiate same-subnet (private) load balancers that report health check status. - Example: `10.2.0.1` + Example: `10.0.0.7` :param source_ip_address: The source_ip_address of this HealthCheckResult. @@ -151,7 +151,9 @@ def source_ip_address(self, source_ip_address): def subnet_id(self): """ **[Required]** Gets the subnet_id of this HealthCheckResult. - The OCID of the subnet hosting the load balancer that reported this health check status. + The `OCID`__ of the subnet hosting the load balancer that reported this health check status. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The subnet_id of this HealthCheckResult. @@ -163,7 +165,9 @@ def subnet_id(self): def subnet_id(self, subnet_id): """ Sets the subnet_id of this HealthCheckResult. - The OCID of the subnet hosting the load balancer that reported this health check status. + The `OCID`__ of the subnet hosting the load balancer that reported this health check status. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param subnet_id: The subnet_id of this HealthCheckResult. diff --git a/src/oci/load_balancer/models/health_checker.py b/src/oci/load_balancer/models/health_checker.py index 80fbcc936e..9af5cadac4 100644 --- a/src/oci/load_balancer/models/health_checker.py +++ b/src/oci/load_balancer/models/health_checker.py @@ -90,7 +90,7 @@ def interval_in_millis(self): Gets the interval_in_millis of this HealthChecker. The interval between health checks, in milliseconds. The default is 10000 (10 seconds). - Example: `30000` + Example: `10000` :return: The interval_in_millis of this HealthChecker. @@ -104,7 +104,7 @@ def interval_in_millis(self, interval_in_millis): Sets the interval_in_millis of this HealthChecker. The interval between health checks, in milliseconds. The default is 10000 (10 seconds). - Example: `30000` + Example: `10000` :param interval_in_millis: The interval_in_millis of this HealthChecker. @@ -176,7 +176,7 @@ def response_body_regex(self): **[Required]** Gets the response_body_regex of this HealthChecker. A regular expression for parsing the response body from the backend server. - Example: `^(500|40[1348])$` + Example: `^((?!false).|\\s)*$` :return: The response_body_regex of this HealthChecker. @@ -190,7 +190,7 @@ def response_body_regex(self, response_body_regex): Sets the response_body_regex of this HealthChecker. A regular expression for parsing the response body from the backend server. - Example: `^(500|40[1348])$` + Example: `^((?!false).|\\s)*$` :param response_body_regex: The response_body_regex of this HealthChecker. @@ -263,7 +263,7 @@ def timeout_in_millis(self): The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. Defaults to 3000 (3 seconds). - Example: `6000` + Example: `3000` :return: The timeout_in_millis of this HealthChecker. @@ -278,7 +278,7 @@ def timeout_in_millis(self, timeout_in_millis): The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. Defaults to 3000 (3 seconds). - Example: `6000` + Example: `3000` :param timeout_in_millis: The timeout_in_millis of this HealthChecker. diff --git a/src/oci/load_balancer/models/health_checker_details.py b/src/oci/load_balancer/models/health_checker_details.py index 7e0b4bf345..081692b8a8 100644 --- a/src/oci/load_balancer/models/health_checker_details.py +++ b/src/oci/load_balancer/models/health_checker_details.py @@ -87,7 +87,7 @@ def interval_in_millis(self): Gets the interval_in_millis of this HealthCheckerDetails. The interval between health checks, in milliseconds. - Example: `30000` + Example: `10000` :return: The interval_in_millis of this HealthCheckerDetails. @@ -101,7 +101,7 @@ def interval_in_millis(self, interval_in_millis): Sets the interval_in_millis of this HealthCheckerDetails. The interval between health checks, in milliseconds. - Example: `30000` + Example: `10000` :param interval_in_millis: The interval_in_millis of this HealthCheckerDetails. @@ -173,7 +173,7 @@ def response_body_regex(self): Gets the response_body_regex of this HealthCheckerDetails. A regular expression for parsing the response body from the backend server. - Example: `^(500|40[1348])$` + Example: `^((?!false).|\\s)*$` :return: The response_body_regex of this HealthCheckerDetails. @@ -187,7 +187,7 @@ def response_body_regex(self, response_body_regex): Sets the response_body_regex of this HealthCheckerDetails. A regular expression for parsing the response body from the backend server. - Example: `^(500|40[1348])$` + Example: `^((?!false).|\\s)*$` :param response_body_regex: The response_body_regex of this HealthCheckerDetails. @@ -258,7 +258,7 @@ def timeout_in_millis(self): The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. - Example: `6000` + Example: `3000` :return: The timeout_in_millis of this HealthCheckerDetails. @@ -273,7 +273,7 @@ def timeout_in_millis(self, timeout_in_millis): The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. - Example: `6000` + Example: `3000` :param timeout_in_millis: The timeout_in_millis of this HealthCheckerDetails. diff --git a/src/oci/load_balancer/models/hostname.py b/src/oci/load_balancer/models/hostname.py new file mode 100644 index 0000000000..16973bbd8f --- /dev/null +++ b/src/oci/load_balancer/models/hostname.py @@ -0,0 +1,116 @@ +# coding: utf-8 +# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Hostname(object): + """ + A hostname resource associated with a load balancer for use by one or more listeners. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Hostname object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param hostname: + The value to assign to the hostname property of this Hostname. + :type hostname: str + + :param name: + The value to assign to the name property of this Hostname. + :type name: str + + """ + self.swagger_types = { + 'hostname': 'str', + 'name': 'str' + } + + self.attribute_map = { + 'hostname': 'hostname', + 'name': 'name' + } + + self._hostname = None + self._name = None + + @property + def hostname(self): + """ + **[Required]** Gets the hostname of this Hostname. + A virtual hostname. For more information about virtual hostname string construction, see + `Managing Request Routing`__. + + Example: `app.example.com` + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm#routing + + + :return: The hostname of this Hostname. + :rtype: str + """ + return self._hostname + + @hostname.setter + def hostname(self, hostname): + """ + Sets the hostname of this Hostname. + A virtual hostname. For more information about virtual hostname string construction, see + `Managing Request Routing`__. + + Example: `app.example.com` + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm#routing + + + :param hostname: The hostname of this Hostname. + :type: str + """ + self._hostname = hostname + + @property + def name(self): + """ + **[Required]** Gets the name of this Hostname. + A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential + information. + + Example: `example_hostname_001` + + + :return: The name of this Hostname. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Hostname. + A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential + information. + + Example: `example_hostname_001` + + + :param name: The name of this Hostname. + :type: str + """ + self._name = name + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/load_balancer/models/hostname_details.py b/src/oci/load_balancer/models/hostname_details.py new file mode 100644 index 0000000000..a4db840b4f --- /dev/null +++ b/src/oci/load_balancer/models/hostname_details.py @@ -0,0 +1,114 @@ +# coding: utf-8 +# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HostnameDetails(object): + """ + The details of a hostname resource associated with a load balancer. + """ + + def __init__(self, **kwargs): + """ + Initializes a new HostnameDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param hostname: + The value to assign to the hostname property of this HostnameDetails. + :type hostname: str + + :param name: + The value to assign to the name property of this HostnameDetails. + :type name: str + + """ + self.swagger_types = { + 'hostname': 'str', + 'name': 'str' + } + + self.attribute_map = { + 'hostname': 'hostname', + 'name': 'name' + } + + self._hostname = None + self._name = None + + @property + def hostname(self): + """ + **[Required]** Gets the hostname of this HostnameDetails. + A virtual hostname. For more information about virtual hostname string construction, see + `Managing Request Routing`__. + + Example: `app.example.com` + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm#routing + + + :return: The hostname of this HostnameDetails. + :rtype: str + """ + return self._hostname + + @hostname.setter + def hostname(self, hostname): + """ + Sets the hostname of this HostnameDetails. + A virtual hostname. For more information about virtual hostname string construction, see + `Managing Request Routing`__. + + Example: `app.example.com` + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm#routing + + + :param hostname: The hostname of this HostnameDetails. + :type: str + """ + self._hostname = hostname + + @property + def name(self): + """ + **[Required]** Gets the name of this HostnameDetails. + The name of the hostname resource. + + Example: `example_hostname_001` + + + :return: The name of this HostnameDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this HostnameDetails. + The name of the hostname resource. + + Example: `example_hostname_001` + + + :param name: The name of this HostnameDetails. + :type: str + """ + self._name = name + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/load_balancer/models/ip_address.py b/src/oci/load_balancer/models/ip_address.py index aac0fdbf8c..b6855d3af8 100644 --- a/src/oci/load_balancer/models/ip_address.py +++ b/src/oci/load_balancer/models/ip_address.py @@ -45,7 +45,7 @@ def ip_address(self): **[Required]** Gets the ip_address of this IpAddress. An IP address. - Example: `128.148.10.20` + Example: `192.168.0.3` :return: The ip_address of this IpAddress. @@ -59,7 +59,7 @@ def ip_address(self, ip_address): Sets the ip_address of this IpAddress. An IP address. - Example: `128.148.10.20` + Example: `192.168.0.3` :param ip_address: The ip_address of this IpAddress. diff --git a/src/oci/load_balancer/models/listener.py b/src/oci/load_balancer/models/listener.py index 62ebd3077f..c0148a93b3 100644 --- a/src/oci/load_balancer/models/listener.py +++ b/src/oci/load_balancer/models/listener.py @@ -13,7 +13,7 @@ class Listener(object): For more information on backend set configuration, see `Managing Load Balancer Listeners`__. - __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managinglisteners.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managinglisteners.htm """ def __init__(self, **kwargs): @@ -29,6 +29,10 @@ def __init__(self, **kwargs): The value to assign to the default_backend_set_name property of this Listener. :type default_backend_set_name: str + :param hostname_names: + The value to assign to the hostname_names property of this Listener. + :type hostname_names: list[str] + :param name: The value to assign to the name property of this Listener. :type name: str @@ -53,6 +57,7 @@ def __init__(self, **kwargs): self.swagger_types = { 'connection_configuration': 'ConnectionConfiguration', 'default_backend_set_name': 'str', + 'hostname_names': 'list[str]', 'name': 'str', 'path_route_set_name': 'str', 'port': 'int', @@ -63,6 +68,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'connection_configuration': 'connectionConfiguration', 'default_backend_set_name': 'defaultBackendSetName', + 'hostname_names': 'hostnameNames', 'name': 'name', 'path_route_set_name': 'pathRouteSetName', 'port': 'port', @@ -72,6 +78,7 @@ def __init__(self, **kwargs): self._connection_configuration = None self._default_backend_set_name = None + self._hostname_names = None self._name = None self._path_route_set_name = None self._port = None @@ -104,7 +111,7 @@ def default_backend_set_name(self): **[Required]** Gets the default_backend_set_name of this Listener. The name of the associated backend set. - Example: `My_backend_set` + Example: `example_backend_set` :return: The default_backend_set_name of this Listener. @@ -118,7 +125,7 @@ def default_backend_set_name(self, default_backend_set_name): Sets the default_backend_set_name of this Listener. The name of the associated backend set. - Example: `My_backend_set` + Example: `example_backend_set` :param default_backend_set_name: The default_backend_set_name of this Listener. @@ -126,13 +133,37 @@ def default_backend_set_name(self, default_backend_set_name): """ self._default_backend_set_name = default_backend_set_name + @property + def hostname_names(self): + """ + Gets the hostname_names of this Listener. + An array of hostname resource names. + + + :return: The hostname_names of this Listener. + :rtype: list[str] + """ + return self._hostname_names + + @hostname_names.setter + def hostname_names(self, hostname_names): + """ + Sets the hostname_names of this Listener. + An array of hostname resource names. + + + :param hostname_names: The hostname_names of this Listener. + :type: list[str] + """ + self._hostname_names = hostname_names + @property def name(self): """ **[Required]** Gets the name of this Listener. A friendly name for the listener. It must be unique and it cannot be changed. - Example: `My listener` + Example: `example_listener` :return: The name of this Listener. @@ -146,7 +177,7 @@ def name(self, name): Sets the name of this Listener. A friendly name for the listener. It must be unique and it cannot be changed. - Example: `My listener` + Example: `example_listener` :param name: The name of this Listener. @@ -161,7 +192,7 @@ def path_route_set_name(self): The name of the set of path-based routing rules, :class:`PathRouteSet`, applied to this listener's traffic. - Example: `path-route-set-001` + Example: `example_path_route_set` :return: The path_route_set_name of this Listener. @@ -176,7 +207,7 @@ def path_route_set_name(self, path_route_set_name): The name of the set of path-based routing rules, :class:`PathRouteSet`, applied to this listener's traffic. - Example: `path-route-set-001` + Example: `example_path_route_set` :param path_route_set_name: The path_route_set_name of this Listener. diff --git a/src/oci/load_balancer/models/listener_details.py b/src/oci/load_balancer/models/listener_details.py index 5fde16023c..1b27b4538c 100644 --- a/src/oci/load_balancer/models/listener_details.py +++ b/src/oci/load_balancer/models/listener_details.py @@ -25,6 +25,10 @@ def __init__(self, **kwargs): The value to assign to the default_backend_set_name property of this ListenerDetails. :type default_backend_set_name: str + :param hostname_names: + The value to assign to the hostname_names property of this ListenerDetails. + :type hostname_names: list[str] + :param path_route_set_name: The value to assign to the path_route_set_name property of this ListenerDetails. :type path_route_set_name: str @@ -45,6 +49,7 @@ def __init__(self, **kwargs): self.swagger_types = { 'connection_configuration': 'ConnectionConfiguration', 'default_backend_set_name': 'str', + 'hostname_names': 'list[str]', 'path_route_set_name': 'str', 'port': 'int', 'protocol': 'str', @@ -54,6 +59,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'connection_configuration': 'connectionConfiguration', 'default_backend_set_name': 'defaultBackendSetName', + 'hostname_names': 'hostnameNames', 'path_route_set_name': 'pathRouteSetName', 'port': 'port', 'protocol': 'protocol', @@ -62,6 +68,7 @@ def __init__(self, **kwargs): self._connection_configuration = None self._default_backend_set_name = None + self._hostname_names = None self._path_route_set_name = None self._port = None self._protocol = None @@ -93,7 +100,7 @@ def default_backend_set_name(self): **[Required]** Gets the default_backend_set_name of this ListenerDetails. The name of the associated backend set. - Example: `My_backend_set` + Example: `example_backend_set` :return: The default_backend_set_name of this ListenerDetails. @@ -107,7 +114,7 @@ def default_backend_set_name(self, default_backend_set_name): Sets the default_backend_set_name of this ListenerDetails. The name of the associated backend set. - Example: `My_backend_set` + Example: `example_backend_set` :param default_backend_set_name: The default_backend_set_name of this ListenerDetails. @@ -115,6 +122,30 @@ def default_backend_set_name(self, default_backend_set_name): """ self._default_backend_set_name = default_backend_set_name + @property + def hostname_names(self): + """ + Gets the hostname_names of this ListenerDetails. + An array of hostname resource names. + + + :return: The hostname_names of this ListenerDetails. + :rtype: list[str] + """ + return self._hostname_names + + @hostname_names.setter + def hostname_names(self, hostname_names): + """ + Sets the hostname_names of this ListenerDetails. + An array of hostname resource names. + + + :param hostname_names: The hostname_names of this ListenerDetails. + :type: list[str] + """ + self._hostname_names = hostname_names + @property def path_route_set_name(self): """ @@ -122,7 +153,7 @@ def path_route_set_name(self): The name of the set of path-based routing rules, :class:`PathRouteSet`, applied to this listener's traffic. - Example: `path-route-set-001` + Example: `example_path_route_set` :return: The path_route_set_name of this ListenerDetails. @@ -137,7 +168,7 @@ def path_route_set_name(self, path_route_set_name): The name of the set of path-based routing rules, :class:`PathRouteSet`, applied to this listener's traffic. - Example: `path-route-set-001` + Example: `example_path_route_set` :param path_route_set_name: The path_route_set_name of this ListenerDetails. diff --git a/src/oci/load_balancer/models/load_balancer.py b/src/oci/load_balancer/models/load_balancer.py index 81309bffe7..1cfe379010 100644 --- a/src/oci/load_balancer/models/load_balancer.py +++ b/src/oci/load_balancer/models/load_balancer.py @@ -67,6 +67,10 @@ def __init__(self, **kwargs): The value to assign to the display_name property of this LoadBalancer. :type display_name: str + :param hostnames: + The value to assign to the hostnames property of this LoadBalancer. + :type hostnames: dict(str, Hostname) + :param id: The value to assign to the id property of this LoadBalancer. :type id: str @@ -111,6 +115,7 @@ def __init__(self, **kwargs): 'certificates': 'dict(str, Certificate)', 'compartment_id': 'str', 'display_name': 'str', + 'hostnames': 'dict(str, Hostname)', 'id': 'str', 'ip_addresses': 'list[IpAddress]', 'is_private': 'bool', @@ -127,6 +132,7 @@ def __init__(self, **kwargs): 'certificates': 'certificates', 'compartment_id': 'compartmentId', 'display_name': 'displayName', + 'hostnames': 'hostnames', 'id': 'id', 'ip_addresses': 'ipAddresses', 'is_private': 'isPrivate', @@ -142,6 +148,7 @@ def __init__(self, **kwargs): self._certificates = None self._compartment_id = None self._display_name = None + self._hostnames = None self._id = None self._ip_addresses = None self._is_private = None @@ -226,7 +233,7 @@ def display_name(self): **[Required]** Gets the display_name of this LoadBalancer. A user-friendly name. It does not have to be unique, and it is changeable. - Example: `My load balancer` + Example: `example_load_balancer` :return: The display_name of this LoadBalancer. @@ -240,7 +247,7 @@ def display_name(self, display_name): Sets the display_name of this LoadBalancer. A user-friendly name. It does not have to be unique, and it is changeable. - Example: `My load balancer` + Example: `example_load_balancer` :param display_name: The display_name of this LoadBalancer. @@ -248,6 +255,26 @@ def display_name(self, display_name): """ self._display_name = display_name + @property + def hostnames(self): + """ + Gets the hostnames of this LoadBalancer. + + :return: The hostnames of this LoadBalancer. + :rtype: dict(str, Hostname) + """ + return self._hostnames + + @hostnames.setter + def hostnames(self, hostnames): + """ + Sets the hostnames of this LoadBalancer. + + :param hostnames: The hostnames of this LoadBalancer. + :type: dict(str, Hostname) + """ + self._hostnames = hostnames + @property def id(self): """ @@ -318,6 +345,8 @@ def is_private(self): hosts the secondary (standby) load balancer. A public load balancer is accessible from the internet, depending on your VCN's `security list rules`__. + Example: `true` + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm @@ -344,6 +373,8 @@ def is_private(self, is_private): hosts the secondary (standby) load balancer. A public load balancer is accessible from the internet, depending on your VCN's `security list rules`__. + Example: `true` + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm diff --git a/src/oci/load_balancer/models/load_balancer_health.py b/src/oci/load_balancer/models/load_balancer_health.py index b6ef9e03d3..9b3060fd02 100644 --- a/src/oci/load_balancer/models/load_balancer_health.py +++ b/src/oci/load_balancer/models/load_balancer_health.py @@ -88,7 +88,7 @@ def critical_state_backend_set_names(self): A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the friendly name you assigned when you created it. - Example: `My_backend_set` + Example: `example_backend_set` :return: The critical_state_backend_set_names of this LoadBalancerHealth. @@ -103,7 +103,7 @@ def critical_state_backend_set_names(self, critical_state_backend_set_names): A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the friendly name you assigned when you created it. - Example: `My_backend_set` + Example: `example_backend_set` :param critical_state_backend_set_names: The critical_state_backend_set_names of this LoadBalancerHealth. @@ -212,7 +212,7 @@ def unknown_state_backend_set_names(self): A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the friendly name you assigned when you created it. - Example: `Backend_set2` + Example: `example_backend_set2` :return: The unknown_state_backend_set_names of this LoadBalancerHealth. @@ -227,7 +227,7 @@ def unknown_state_backend_set_names(self, unknown_state_backend_set_names): A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the friendly name you assigned when you created it. - Example: `Backend_set2` + Example: `example_backend_set2` :param unknown_state_backend_set_names: The unknown_state_backend_set_names of this LoadBalancerHealth. @@ -242,7 +242,7 @@ def warning_state_backend_set_names(self): A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the friendly name you assigned when you created it. - Example: `Backend_set3` + Example: `example_backend_set3` :return: The warning_state_backend_set_names of this LoadBalancerHealth. @@ -257,7 +257,7 @@ def warning_state_backend_set_names(self, warning_state_backend_set_names): A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the friendly name you assigned when you created it. - Example: `Backend_set3` + Example: `example_backend_set3` :param warning_state_backend_set_names: The warning_state_backend_set_names of this LoadBalancerHealth. diff --git a/src/oci/load_balancer/models/load_balancer_policy.py b/src/oci/load_balancer/models/load_balancer_policy.py index 95f68a360f..02a196eb2b 100644 --- a/src/oci/load_balancer/models/load_balancer_policy.py +++ b/src/oci/load_balancer/models/load_balancer_policy.py @@ -40,7 +40,9 @@ def __init__(self, **kwargs): def name(self): """ **[Required]** Gets the name of this LoadBalancerPolicy. - The name of the load balancing policy. + The name of a load balancing policy. + + Example: 'LEAST_CONNECTIONS' :return: The name of this LoadBalancerPolicy. @@ -52,7 +54,9 @@ def name(self): def name(self, name): """ Sets the name of this LoadBalancerPolicy. - The name of the load balancing policy. + The name of a load balancing policy. + + Example: 'LEAST_CONNECTIONS' :param name: The name of this LoadBalancerPolicy. diff --git a/src/oci/load_balancer/models/load_balancer_protocol.py b/src/oci/load_balancer/models/load_balancer_protocol.py index 62fd21356c..33ebc042b8 100644 --- a/src/oci/load_balancer/models/load_balancer_protocol.py +++ b/src/oci/load_balancer/models/load_balancer_protocol.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class LoadBalancerProtocol(object): """ - The protocol that defines the type of traffic accepted by a listener. + A protocol that defines the type of traffic accepted by a listener. """ def __init__(self, **kwargs): @@ -36,7 +36,9 @@ def __init__(self, **kwargs): def name(self): """ **[Required]** Gets the name of this LoadBalancerProtocol. - The name of the protocol. + The name of a protocol. + + Example: 'HTTP' :return: The name of this LoadBalancerProtocol. @@ -48,7 +50,9 @@ def name(self): def name(self, name): """ Sets the name of this LoadBalancerProtocol. - The name of the protocol. + The name of a protocol. + + Example: 'HTTP' :param name: The name of this LoadBalancerProtocol. diff --git a/src/oci/load_balancer/models/load_balancer_shape.py b/src/oci/load_balancer/models/load_balancer_shape.py index 50d05fead2..1a7b6de97c 100644 --- a/src/oci/load_balancer/models/load_balancer_shape.py +++ b/src/oci/load_balancer/models/load_balancer_shape.py @@ -42,6 +42,8 @@ def name(self): **[Required]** Gets the name of this LoadBalancerShape. The name of the shape. + Example: `100Mbps` + :return: The name of this LoadBalancerShape. :rtype: str @@ -54,6 +56,8 @@ def name(self, name): Sets the name of this LoadBalancerShape. The name of the shape. + Example: `100Mbps` + :param name: The name of this LoadBalancerShape. :type: str diff --git a/src/oci/load_balancer/models/path_route.py b/src/oci/load_balancer/models/path_route.py index de9197fe7f..dcb7349353 100644 --- a/src/oci/load_balancer/models/path_route.py +++ b/src/oci/load_balancer/models/path_route.py @@ -54,7 +54,7 @@ def backend_set_name(self): **[Required]** Gets the backend_set_name of this PathRoute. The name of the target backend set for requests where the incoming URI matches the specified path. - Example: `My_backend_set` + Example: `example_backend_set` :return: The backend_set_name of this PathRoute. @@ -68,7 +68,7 @@ def backend_set_name(self, backend_set_name): Sets the backend_set_name of this PathRoute. The name of the target backend set for requests where the incoming URI matches the specified path. - Example: `My_backend_set` + Example: `example_backend_set` :param backend_set_name: The backend_set_name of this PathRoute. diff --git a/src/oci/load_balancer/models/path_route_set.py b/src/oci/load_balancer/models/path_route_set.py index e145886826..3664f65dcf 100644 --- a/src/oci/load_balancer/models/path_route_set.py +++ b/src/oci/load_balancer/models/path_route_set.py @@ -48,7 +48,7 @@ def name(self): **[Required]** Gets the name of this PathRouteSet. The unique name for this set of path route rules. Avoid entering confidential information. - Example: `path-route-set-001` + Example: `example_path_route_set` :return: The name of this PathRouteSet. @@ -62,7 +62,7 @@ def name(self, name): Sets the name of this PathRouteSet. The unique name for this set of path route rules. Avoid entering confidential information. - Example: `path-route-set-001` + Example: `example_path_route_set` :param name: The name of this PathRouteSet. diff --git a/src/oci/load_balancer/models/session_persistence_configuration_details.py b/src/oci/load_balancer/models/session_persistence_configuration_details.py index b9941c5959..d69ae70969 100644 --- a/src/oci/load_balancer/models/session_persistence_configuration_details.py +++ b/src/oci/load_balancer/models/session_persistence_configuration_details.py @@ -56,7 +56,7 @@ def cookie_name(self): The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. - Example: `myCookieName` + Example: `example_cookie` :return: The cookie_name of this SessionPersistenceConfigurationDetails. @@ -71,7 +71,7 @@ def cookie_name(self, cookie_name): The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. - Example: `myCookieName` + Example: `example_cookie` :param cookie_name: The cookie_name of this SessionPersistenceConfigurationDetails. @@ -86,7 +86,7 @@ def disable_fallback(self): Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. - Example: `true` + Example: `false` :return: The disable_fallback of this SessionPersistenceConfigurationDetails. @@ -101,7 +101,7 @@ def disable_fallback(self, disable_fallback): Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. - Example: `true` + Example: `false` :param disable_fallback: The disable_fallback of this SessionPersistenceConfigurationDetails. diff --git a/src/oci/load_balancer/models/ssl_configuration.py b/src/oci/load_balancer/models/ssl_configuration.py index f1362c79ad..474f16129d 100644 --- a/src/oci/load_balancer/models/ssl_configuration.py +++ b/src/oci/load_balancer/models/ssl_configuration.py @@ -56,7 +56,7 @@ def certificate_name(self): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :return: The certificate_name of this SSLConfiguration. @@ -72,7 +72,7 @@ def certificate_name(self, certificate_name): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :param certificate_name: The certificate_name of this SSLConfiguration. diff --git a/src/oci/load_balancer/models/ssl_configuration_details.py b/src/oci/load_balancer/models/ssl_configuration_details.py index 63a96009f7..943df4b04a 100644 --- a/src/oci/load_balancer/models/ssl_configuration_details.py +++ b/src/oci/load_balancer/models/ssl_configuration_details.py @@ -54,7 +54,7 @@ def certificate_name(self): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :return: The certificate_name of this SSLConfigurationDetails. @@ -70,7 +70,7 @@ def certificate_name(self, certificate_name): Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. - Example: `My_certificate_bundle` + Example: `example_certificate_bundle` :param certificate_name: The certificate_name of this SSLConfigurationDetails. diff --git a/src/oci/load_balancer/models/update_backend_details.py b/src/oci/load_balancer/models/update_backend_details.py index c79ff919d2..1b0fff3f17 100644 --- a/src/oci/load_balancer/models/update_backend_details.py +++ b/src/oci/load_balancer/models/update_backend_details.py @@ -60,7 +60,7 @@ def backup(self): Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy. - Example: `true` + Example: `false` :return: The backup of this UpdateBackendDetails. @@ -75,7 +75,7 @@ def backup(self, backup): Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy. - Example: `true` + Example: `false` :param backup: The backup of this UpdateBackendDetails. @@ -90,7 +90,7 @@ def drain(self): Whether the load balancer should drain this server. Servers marked \"drain\" receive no new incoming traffic. - Example: `true` + Example: `false` :return: The drain of this UpdateBackendDetails. @@ -105,7 +105,7 @@ def drain(self, drain): Whether the load balancer should drain this server. Servers marked \"drain\" receive no new incoming traffic. - Example: `true` + Example: `false` :param drain: The drain of this UpdateBackendDetails. @@ -120,7 +120,7 @@ def offline(self): Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. - Example: `true` + Example: `false` :return: The offline of this UpdateBackendDetails. @@ -135,7 +135,7 @@ def offline(self, offline): Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. - Example: `true` + Example: `false` :param offline: The offline of this UpdateBackendDetails. diff --git a/src/oci/load_balancer/models/update_health_checker_details.py b/src/oci/load_balancer/models/update_health_checker_details.py index bf1786bd59..a28a538127 100644 --- a/src/oci/load_balancer/models/update_health_checker_details.py +++ b/src/oci/load_balancer/models/update_health_checker_details.py @@ -87,7 +87,7 @@ def interval_in_millis(self): **[Required]** Gets the interval_in_millis of this UpdateHealthCheckerDetails. The interval between health checks, in milliseconds. - Example: `30000` + Example: `10000` :return: The interval_in_millis of this UpdateHealthCheckerDetails. @@ -101,7 +101,7 @@ def interval_in_millis(self, interval_in_millis): Sets the interval_in_millis of this UpdateHealthCheckerDetails. The interval between health checks, in milliseconds. - Example: `30000` + Example: `10000` :param interval_in_millis: The interval_in_millis of this UpdateHealthCheckerDetails. @@ -171,7 +171,7 @@ def response_body_regex(self): **[Required]** Gets the response_body_regex of this UpdateHealthCheckerDetails. A regular expression for parsing the response body from the backend server. - Example: `^(500|40[1348])$` + Example: `^((?!false).|\\s)*$` :return: The response_body_regex of this UpdateHealthCheckerDetails. @@ -185,7 +185,7 @@ def response_body_regex(self, response_body_regex): Sets the response_body_regex of this UpdateHealthCheckerDetails. A regular expression for parsing the response body from the backend server. - Example: `^(500|40[1348])$` + Example: `^((?!false).|\\s)*$` :param response_body_regex: The response_body_regex of this UpdateHealthCheckerDetails. @@ -256,7 +256,7 @@ def timeout_in_millis(self): The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. - Example: `6000` + Example: `3000` :return: The timeout_in_millis of this UpdateHealthCheckerDetails. @@ -271,7 +271,7 @@ def timeout_in_millis(self, timeout_in_millis): The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. - Example: `6000` + Example: `3000` :param timeout_in_millis: The timeout_in_millis of this UpdateHealthCheckerDetails. diff --git a/src/oci/load_balancer/models/update_hostname_details.py b/src/oci/load_balancer/models/update_hostname_details.py new file mode 100644 index 0000000000..93750f3ed7 --- /dev/null +++ b/src/oci/load_balancer/models/update_hostname_details.py @@ -0,0 +1,83 @@ +# coding: utf-8 +# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateHostnameDetails(object): + """ + The configuration details for updating a virtual hostname. + For more information on virtual hostnames, see + `Managing Request Routing`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateHostnameDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param hostname: + The value to assign to the hostname property of this UpdateHostnameDetails. + :type hostname: str + + """ + self.swagger_types = { + 'hostname': 'str' + } + + self.attribute_map = { + 'hostname': 'hostname' + } + + self._hostname = None + + @property + def hostname(self): + """ + Gets the hostname of this UpdateHostnameDetails. + The virtual hostname to update. For more information about virtual hostname string construction, see + `Managing Request Routing`__. + + Example: `app.example.com` + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm#routing + + + :return: The hostname of this UpdateHostnameDetails. + :rtype: str + """ + return self._hostname + + @hostname.setter + def hostname(self, hostname): + """ + Sets the hostname of this UpdateHostnameDetails. + The virtual hostname to update. For more information about virtual hostname string construction, see + `Managing Request Routing`__. + + Example: `app.example.com` + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm#routing + + + :param hostname: The hostname of this UpdateHostnameDetails. + :type: str + """ + self._hostname = hostname + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/load_balancer/models/update_listener_details.py b/src/oci/load_balancer/models/update_listener_details.py index 4b03f98c51..5af08289be 100644 --- a/src/oci/load_balancer/models/update_listener_details.py +++ b/src/oci/load_balancer/models/update_listener_details.py @@ -25,6 +25,10 @@ def __init__(self, **kwargs): The value to assign to the default_backend_set_name property of this UpdateListenerDetails. :type default_backend_set_name: str + :param hostname_names: + The value to assign to the hostname_names property of this UpdateListenerDetails. + :type hostname_names: list[str] + :param path_route_set_name: The value to assign to the path_route_set_name property of this UpdateListenerDetails. :type path_route_set_name: str @@ -45,6 +49,7 @@ def __init__(self, **kwargs): self.swagger_types = { 'connection_configuration': 'ConnectionConfiguration', 'default_backend_set_name': 'str', + 'hostname_names': 'list[str]', 'path_route_set_name': 'str', 'port': 'int', 'protocol': 'str', @@ -54,6 +59,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'connection_configuration': 'connectionConfiguration', 'default_backend_set_name': 'defaultBackendSetName', + 'hostname_names': 'hostnameNames', 'path_route_set_name': 'pathRouteSetName', 'port': 'port', 'protocol': 'protocol', @@ -62,6 +68,7 @@ def __init__(self, **kwargs): self._connection_configuration = None self._default_backend_set_name = None + self._hostname_names = None self._path_route_set_name = None self._port = None self._protocol = None @@ -93,7 +100,7 @@ def default_backend_set_name(self): **[Required]** Gets the default_backend_set_name of this UpdateListenerDetails. The name of the associated backend set. - Example: `My_backend_set` + Example: `example_backend_set` :return: The default_backend_set_name of this UpdateListenerDetails. @@ -107,7 +114,7 @@ def default_backend_set_name(self, default_backend_set_name): Sets the default_backend_set_name of this UpdateListenerDetails. The name of the associated backend set. - Example: `My_backend_set` + Example: `example_backend_set` :param default_backend_set_name: The default_backend_set_name of this UpdateListenerDetails. @@ -115,6 +122,30 @@ def default_backend_set_name(self, default_backend_set_name): """ self._default_backend_set_name = default_backend_set_name + @property + def hostname_names(self): + """ + Gets the hostname_names of this UpdateListenerDetails. + An array of hostname resource names. + + + :return: The hostname_names of this UpdateListenerDetails. + :rtype: list[str] + """ + return self._hostname_names + + @hostname_names.setter + def hostname_names(self, hostname_names): + """ + Sets the hostname_names of this UpdateListenerDetails. + An array of hostname resource names. + + + :param hostname_names: The hostname_names of this UpdateListenerDetails. + :type: list[str] + """ + self._hostname_names = hostname_names + @property def path_route_set_name(self): """ @@ -122,7 +153,7 @@ def path_route_set_name(self): The name of the set of path-based routing rules, :class:`PathRouteSet`, applied to this listener's traffic. - Example: `path-route-set-001` + Example: `example_path_route_set` :return: The path_route_set_name of this UpdateListenerDetails. @@ -137,7 +168,7 @@ def path_route_set_name(self, path_route_set_name): The name of the set of path-based routing rules, :class:`PathRouteSet`, applied to this listener's traffic. - Example: `path-route-set-001` + Example: `example_path_route_set` :param path_route_set_name: The path_route_set_name of this UpdateListenerDetails. diff --git a/src/oci/load_balancer/models/update_load_balancer_details.py b/src/oci/load_balancer/models/update_load_balancer_details.py index 768662cd31..7b53ab519d 100644 --- a/src/oci/load_balancer/models/update_load_balancer_details.py +++ b/src/oci/load_balancer/models/update_load_balancer_details.py @@ -39,7 +39,7 @@ def display_name(self): The user-friendly display name for the load balancer. It does not have to be unique, and it is changeable. Avoid entering confidential information. - Example: `My load balancer` + Example: `example_load_balancer` :return: The display_name of this UpdateLoadBalancerDetails. @@ -54,7 +54,7 @@ def display_name(self, display_name): The user-friendly display name for the load balancer. It does not have to be unique, and it is changeable. Avoid entering confidential information. - Example: `My load balancer` + Example: `example_load_balancer` :param display_name: The display_name of this UpdateLoadBalancerDetails. diff --git a/src/oci/load_balancer/models/work_request.py b/src/oci/load_balancer/models/work_request.py index baa0adcb8f..59f4057d38 100644 --- a/src/oci/load_balancer/models/work_request.py +++ b/src/oci/load_balancer/models/work_request.py @@ -312,6 +312,8 @@ def type(self): **[Required]** Gets the type of this WorkRequest. The type of action the work request represents. + Example: `CreateListener` + :return: The type of this WorkRequest. :rtype: str @@ -324,6 +326,8 @@ def type(self, type): Sets the type of this WorkRequest. The type of action the work request represents. + Example: `CreateListener` + :param type: The type of this WorkRequest. :type: str diff --git a/src/oci/object_storage/object_storage_client.py b/src/oci/object_storage/object_storage_client.py index 1806e61fc3..d6c1d0980a 100644 --- a/src/oci/object_storage/object_storage_client.py +++ b/src/oci/object_storage/object_storage_client.py @@ -101,6 +101,14 @@ def abort_multipart_upload(self, namespace_name, bucket_name, object_name, uploa :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -195,6 +203,14 @@ def commit_multipart_upload(self, namespace_name, bucket_name, object_name, uplo :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -276,6 +292,14 @@ def create_bucket(self, namespace_name, create_bucket_details, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.Bucket` :rtype: :class:`~oci.response.Response` """ @@ -358,6 +382,14 @@ def create_multipart_upload(self, namespace_name, bucket_name, create_multipart_ :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.MultipartUpload` :rtype: :class:`~oci.response.Response` """ @@ -437,6 +469,14 @@ def create_preauthenticated_request(self, namespace_name, bucket_name, create_pr :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.PreauthenticatedRequest` :rtype: :class:`~oci.response.Response` """ @@ -513,6 +553,14 @@ def delete_bucket(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -591,6 +639,14 @@ def delete_object(self, namespace_name, bucket_name, object_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -666,6 +722,14 @@ def delete_preauthenticated_request(self, namespace_name, bucket_name, par_id, * :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -743,6 +807,14 @@ def get_bucket(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.Bucket` :rtype: :class:`~oci.response.Response` """ @@ -811,6 +883,14 @@ def get_namespace(self, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type str :rtype: :class:`~oci.response.Response` """ @@ -869,6 +949,14 @@ def get_namespace_metadata(self, namespace_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.NamespaceMetadata` :rtype: :class:`~oci.response.Response` """ @@ -956,6 +1044,14 @@ def get_object(self, namespace_name, bucket_name, object_name, **kwargs): __ https://tools.ietf.org/rfc/rfc7233 + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type stream :rtype: :class:`~oci.response.Response` """ @@ -1037,6 +1133,14 @@ def get_preauthenticated_request(self, namespace_name, bucket_name, par_id, **kw :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.PreauthenticatedRequestSummary` :rtype: :class:`~oci.response.Response` """ @@ -1116,6 +1220,14 @@ def head_bucket(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1200,6 +1312,14 @@ def head_object(self, namespace_name, bucket_name, object_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1292,6 +1412,14 @@ def list_buckets(self, namespace_name, compartment_id, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.object_storage.models.BucketSummary` :rtype: :class:`~oci.response.Response` """ @@ -1395,6 +1523,14 @@ def list_multipart_upload_parts(self, namespace_name, bucket_name, object_name, :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.object_storage.models.MultipartUploadPartSummary` :rtype: :class:`~oci.response.Response` """ @@ -1483,6 +1619,14 @@ def list_multipart_uploads(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.object_storage.models.MultipartUpload` :rtype: :class:`~oci.response.Response` """ @@ -1596,6 +1740,14 @@ def list_objects(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.ListObjects` :rtype: :class:`~oci.response.Response` """ @@ -1693,6 +1845,14 @@ def list_preauthenticated_requests(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.object_storage.models.PreauthenticatedRequestSummary` :rtype: :class:`~oci.response.Response` """ @@ -1813,6 +1973,14 @@ def put_object(self, namespace_name, bucket_name, object_name, put_object_body, "opc-meta-" will be appended to each dict key before it is sent to the server. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1916,6 +2084,14 @@ def rename_object(self, namespace_name, bucket_name, rename_object_details, **kw :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -1990,6 +2166,14 @@ def restore_objects(self, namespace_name, bucket_name, restore_objects_details, :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ @@ -2067,6 +2251,14 @@ def update_bucket(self, namespace_name, bucket_name, update_bucket_details, **kw :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.Bucket` :rtype: :class:`~oci.response.Response` """ @@ -2143,6 +2335,14 @@ def update_namespace_metadata(self, namespace_name, update_namespace_metadata_de :param str opc_client_request_id: (optional) The client request ID for tracing. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.NamespaceMetadata` :rtype: :class:`~oci.response.Response` """ @@ -2244,6 +2444,14 @@ def upload_part(self, namespace_name, bucket_name, object_name, upload_id, uploa :param str content_md5: (optional) The base-64 encoded MD5 hash of the body. + :param obj retry_strategy: (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 :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.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 :py:class:`~oci.retry.NoneRetryStrategy`. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/object_storage/transfer/internal/multipart_object_assembler.py b/src/oci/object_storage/transfer/internal/multipart_object_assembler.py index 287d08ca30..4c94a4f409 100644 --- a/src/oci/object_storage/transfer/internal/multipart_object_assembler.py +++ b/src/oci/object_storage/transfer/internal/multipart_object_assembler.py @@ -179,7 +179,8 @@ def add_parts_from_file(self, file_path): file_object.seek(0, io.SEEK_SET) offset = 0 while file_object.tell() < end: - self.add_part_from_file(file_path, offset=offset, size=self.part_size) + remaining = end - offset + self.add_part_from_file(file_path, offset=offset, size=self.part_size if remaining > self.part_size else remaining) offset += self.part_size file_object.seek(offset, io.SEEK_SET) diff --git a/src/oci/signer.py b/src/oci/signer.py index b6a9afca24..199bdb4611 100644 --- a/src/oci/signer.py +++ b/src/oci/signer.py @@ -10,11 +10,10 @@ import functools import os -import httpsig_cffi.sign -import httpsig_cffi.utils import requests.auth import six +from ._vendor import httpsig_cffi from .exceptions import InvalidPrivateKey, MissingPrivateKeyPassphrase from cryptography.exceptions import UnsupportedAlgorithm diff --git a/src/oci/util.py b/src/oci/util.py index d4980a4694..655110f9e0 100644 --- a/src/oci/util.py +++ b/src/oci/util.py @@ -1,8 +1,10 @@ # coding: utf-8 # Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. +import base64 import datetime import json +import os.path import pytz import six try: @@ -70,6 +72,26 @@ def value_allowed_none_or_none_sentinel(value_to_test, allowed_values): return value_to_test is None or value_to_test is NONE_SENTINEL or value_to_test in allowed_values +def file_content_as_launch_instance_user_data(file_path): + """ + Takes a file path and returns a Base64-encoded string which can be provided as the value of the ``user_data`` key + in the ``metadata`` dictionary when launching an instance(see :py:class:`~oci.core.models.LaunchInstanceDetails` + for more information). + + :param str file_path: + The path to the file whose contents will be Base64-encoded + + :return: The Base64-encoded string + :rtype: str + """ + + full_path = os.path.expandvars(os.path.expanduser(file_path)) + with open(full_path, 'rb') as f: + file_contents = f.read() + + return base64.b64encode(file_contents).decode('utf-8') + + class Sentinel(object): """Named singletons for clear docstrings. Also used to differentiate an explicit param of None from a lack of argument. diff --git a/src/oci/version.py b/src/oci/version.py index c8a8923752..aad8127147 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -1,4 +1,4 @@ # coding: utf-8 # Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. -__version__ = "1.3.19" +__version__ = "1.3.20" diff --git a/tests/util.py b/tests/util.py index 3251808dca..895b38dfaa 100644 --- a/tests/util.py +++ b/tests/util.py @@ -20,9 +20,12 @@ def random_number_string(): return str(random.randint(0, 10000)) -def unique_name(base_name): +def unique_name(base_name, ignore_vcr=False): if test_config_container.using_vcr_with_mock_responses(): - return '{}_vcr'.format(base_name) + if ignore_vcr: + return base_name + '_' + str(random.randint(0, 10000)) + else: + return '{}_vcr'.format(base_name) else: return base_name + '_' + random_number_string()