diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3826e93960..b636c376b9 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.7 - 2017-09-11 +==================== + +Deprecated +---------- +* The default configuration file location has been changed from ~/.oraclebmc/config to ~/.oci/config. The old location still works if the file at the new location does not exist. + +Added +----- +* Support for the Database service +* Support for instance console connections +* Support for the Load Balancer Health Status API +* Support for Compartment renaming +* Support for managing customer secret keys + +Changed +------- +* The default configuration file location is now ~/.oci/config + ==================== 1.3.6 - 2017-08-10 ==================== @@ -57,7 +77,7 @@ Added Added ------- -* Support for VCN private subnets using the prohibit_public_ip_on_vnic parameter on oraclebmc.core.VirtualNetworkClient.create_subnet. +* Support for VCN private subnets using the prohibit_public_ip_on_vnic parameter on oci.core.VirtualNetworkClient.create_subnet. * Support for FastConnect * Support for list_regions and region subscription operations * First class support for new IAD region diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index eef63b52d4..75a6862228 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,4 +1,4 @@ -Contributing to the Oracle Bare Metal Cloud Services Python SDK +Contributing to the Oracle Cloud Infrastructure Python SDK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ *Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.* diff --git a/README.rst b/README.rst index c0e4092097..0443d39e45 100644 --- a/README.rst +++ b/README.rst @@ -1,21 +1,21 @@ -Oracle Bare Metal Cloud Services Python SDK +Oracle Cloud Infrastructure Python SDK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ===== About ===== -This is the Python SDK for Oracle Bare Metal Cloud Services. Python 2.7+ and 3.5+ are supported. +This is the Python SDK for Oracle Cloud Infrastructure. Python 2.7+ and 3.5+ are supported. .. code-block:: pycon - >>> import oraclebmc + >>> import oci # Set up config - >>> config = oraclebmc.config.from_file( - ... "~/.oraclebmc/config", + >>> config = oci.config.from_file( + ... "~/.oci/config", ... "DEFAULT") # Create a service client - >>> identity = oraclebmc.identity.IdentityClient(config) + >>> identity = oci.identity.IdentityClient(config) # Get the current user >>> user = identity.get_user(config["user"]).data >>> print(user) @@ -31,7 +31,7 @@ This is the Python SDK for Oracle Bare Metal Cloud Services. Python 2.7+ and 3.5 The project is open source and maintained by Oracle Corp. The home page for the project is `here`__. -__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/index.html +__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/index.html ============ Installation @@ -39,12 +39,72 @@ Installation :: - pip install oraclebmc + pip install oci See `the installation guide`__ for installation troubleshooting and alternative install methods. -__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/installation.html +__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/installation.html + +============ +Development +============ + +Getting Started +=============== +Assuming that you have Python and `virtualenv` installed, set up your environment and install the required dependencies like this: + +.. code-block:: sh + + git clone https://github.com/oracle/oci-python-sdk.git + cd oci-python-sdk + virtualenv oci-python-sdk-env + . oci-python-sdk-env/bin/activate + pip install -r requirements.txt + pip install -e . + +You should also set up your configuration files as described `here`__ + +__ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm + +Running Tests +============= +The SDK uses `pytest` as its test framework. You can run tests against Python 2.7 Python 3.5 using the `tox` command. Note that this requires that you have those versions of Python installed, +otherwise you must pass `-e` or run tests directly: + +.. code-block:: sh + + # This will run tests against all configured Pythons in tox.ini (currently 2.7 and 3.5). You need to have those versions installed + tox + + # This will run tests against a specific Python versions + tox -e py27 + +If you wish to run an individual test then you can run: + +.. code-block:: sh + + py.test -s tests/integ/test_launch_instance_tutorial.py + +Generating Documentation +======================== +Sphinx is used for documentation. You can generate HTML locally with the following: + +.. code-block:: sh + + pip install -r requirements.txt + cd docs + make html + +Generating the wheel +==================== +The SDK is packaged as a wheel. In order to generate the wheel you can run: + +.. code-block:: sh + + python setup.py sdist bdist_wheel + +This wheel can then be installed via `pip`. ======== Examples @@ -52,7 +112,7 @@ Examples Examples can be found `here`__. -__ https://github.com/oracle/bmcs-python-sdk/blob/master/examples/ +__ https://github.com/oracle/oci-python-sdk/blob/master/examples/ ============= Documentation @@ -62,8 +122,8 @@ Full documentation, including prerequisites and installation and configuration i API reference can be found `here`__. -__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/index.html -__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/api/index.html +__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/index.html +__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/api/index.html ==== Help @@ -71,7 +131,7 @@ Help See the “Questions or Feedback” section `here`__. -__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/feedback.html +__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/feedback.html ======= Changes @@ -79,17 +139,17 @@ Changes See `CHANGELOG`__. -__ https://github.com/oracle/bmcs-python-sdk/blob/master/CHANGELOG.rst +__ https://github.com/oracle/oci-python-sdk/blob/master/CHANGELOG.rst ============ Contributing ============ -bmcs-python-sdk is an open source project. See `CONTRIBUTING`__ for details. +oci-python-sdk is an open source project. See `CONTRIBUTING`__ for details. -Oracle gratefully acknowledges the contributions to bmcs-python-sdk that have been made by the community. +Oracle gratefully acknowledges the contributions to oci-python-sdk that have been made by the community. -__ https://github.com/oracle/bmcs-python-sdk/blob/master/CONTRIBUTING.rst +__ https://github.com/oracle/oci-python-sdk/blob/master/CONTRIBUTING.rst ============ Known Issues @@ -99,7 +159,7 @@ You can find information on any known issues with the SDK `here`__ and under the project's `GitHub repository`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/knownissues.htm -__ https://github.com/oracle/bmcs-python-sdk +__ https://github.com/oracle/oci-python-sdk ======= License @@ -111,4 +171,4 @@ This SDK and sample is dual licensed under the Universal Permissive License 1.0 See `LICENSE`__ for more details. -__ https://github.com/oracle/bmcs-python-sdk/blob/master/LICENSE.txt +__ https://github.com/oracle/oci-python-sdk/blob/master/LICENSE.txt diff --git a/docs/Makefile b/docs/Makefile index 393bebf123..0794100089 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -92,9 +92,9 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/oraclebmc.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/oci.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/oraclebmc.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/oci.qhc" .PHONY: applehelp applehelp: @@ -111,8 +111,8 @@ devhelp: @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/oraclebmc" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/oraclebmc" + @echo "# mkdir -p $$HOME/.local/share/devhelp/oci" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/oci" @echo "# devhelp" .PHONY: epub diff --git a/docs/api/index.rst b/docs/api/index.rst index c2c8a38210..0bbe3f0dd9 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -1,5 +1,14 @@ .. _api-reference: +.. raw:: html + + + API Reference ~~~~~~~~~~~~~ @@ -15,27 +24,27 @@ API Reference Block Storage ============= -.. autoclass:: oraclebmc.core.blockstorage_client.BlockstorageClient +.. autoclass:: oci.core.blockstorage_client.BlockstorageClient :members: Compute ======= -.. autoclass:: oraclebmc.core.compute_client.ComputeClient +.. autoclass:: oci.core.compute_client.ComputeClient :members: Virtual Network =============== -.. autoclass:: oraclebmc.core.virtual_network_client.VirtualNetworkClient +.. autoclass:: oci.core.virtual_network_client.VirtualNetworkClient :members: -------- Models -------- -.. automodule:: oraclebmc.core.models +.. automodule:: oci.core.models :members: :undoc-members: :imported-members: @@ -48,14 +57,14 @@ Virtual Network Client -------- -.. autoclass:: oraclebmc.identity.identity_client.IdentityClient +.. autoclass:: oci.identity.identity_client.IdentityClient :members: -------- Models -------- -.. automodule:: oraclebmc.identity.models +.. automodule:: oci.identity.models :members: :undoc-members: :imported-members: @@ -68,14 +77,14 @@ Load Balancer Client -------- -.. autoclass:: oraclebmc.load_balancer.load_balancer_client.LoadBalancerClient +.. autoclass:: oci.load_balancer.load_balancer_client.LoadBalancerClient :members: -------- Models -------- -.. automodule:: oraclebmc.load_balancer.models +.. automodule:: oci.load_balancer.models :members: :undoc-members: :imported-members: @@ -88,14 +97,14 @@ Load Balancer Client -------- -.. autoclass:: oraclebmc.object_storage.object_storage_client.ObjectStorageClient +.. autoclass:: oci.object_storage.object_storage_client.ObjectStorageClient :members: -------- Models -------- -.. automodule:: oraclebmc.object_storage.models +.. automodule:: oci.object_storage.models :members: :undoc-members: :imported-members: @@ -105,7 +114,7 @@ Load Balancer Base Client ============= -.. module:: oraclebmc.base_client +.. module:: oci.base_client .. autoclass:: BaseClient :members: call_api, request @@ -114,13 +123,13 @@ Load Balancer Config ======== -.. module:: oraclebmc.config +.. module:: oci.config .. autofunction:: from_file .. autofunction:: validate_config -.. module:: oraclebmc.regions +.. module:: oci.regions .. autofunction:: is_region @@ -131,14 +140,14 @@ Load Balancer Exceptions ============ -.. automodule:: oraclebmc.exceptions +.. automodule:: oci.exceptions :members: ========= Signing ========= -.. module:: oraclebmc.signer +.. module:: oci.signer .. autofunction:: load_private_key_from_file @@ -150,7 +159,7 @@ Load Balancer Utilities =========== -.. module:: oraclebmc.util +.. module:: oci.util .. autofunction:: to_dict @@ -159,7 +168,7 @@ Load Balancer ========= Request ========= -.. module:: oraclebmc.request +.. module:: oci.request .. autoclass:: Request :members: @@ -168,7 +177,7 @@ Request ========= Response ========= -.. module:: oraclebmc.response +.. module:: oci.response .. autoclass:: Response :members: diff --git a/docs/backward-compatibility.rst b/docs/backward-compatibility.rst new file mode 100644 index 0000000000..613abfe079 --- /dev/null +++ b/docs/backward-compatibility.rst @@ -0,0 +1,16 @@ +.. _backward-compatibility: + +.. raw:: html + + + +Backward Compatibility +~~~~~~~~~~~~~~~~~~~~~~ +The top level namespace / package name for the Python SDK has been changed from ``oraclebmc`` to ``oci``, so all of the documentation now references ``oci``. If you are using the ``oraclebmc`` package you should continue to reference ``oraclebmc`` in your code and when interpreting the documentation you should replace ``oci`` with ``oraclebmc`` (i.e. if there is a class defined in the docs as ``oci.base_client.BaseClient`` in the oraclebmc package this class will be called ``oraclebmc.base_client.BaseClient``). + +**Note**: The ``oraclebmc`` package is deprecated and will be removed in March 2018. Please upgrade to the ``oci`` package to avoid interruption at that time. \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 513279bc77..b250f418ff 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,14 +19,14 @@ master_doc = "index" # General information about the project. -project = "oraclebmc" +project = "oci" copyright = "2016, 2017, Oracle" author = "Oracle" try: - release = pkg_resources.get_distribution("oraclebmc").version + release = pkg_resources.get_distribution("oci").version except pkg_resources.DistributionNotFound: - print("To build the documentation, The distribution information of oraclebmc") + print("To build the documentation, The distribution information of oci") print("Has to be available. Either install the package into your") print("development environment or run 'setup.py develop' to setup the") print("metadata. A virtualenv is recommended!") @@ -61,7 +61,7 @@ # The name for this set of Sphinx documents. # " v documentation" by default. # -# html_title = 'oraclebmc vCURRENT_VER' +# html_title = 'oci vCURRENT_VER' # A shorter title for the navigation bar. Default is the same as html_title. # @@ -133,7 +133,7 @@ # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = "oraclebmcdoc" +htmlhelp_basename = "ocidoc" # -- Options for LaTeX output --------------------------------------------- @@ -159,7 +159,7 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, "oraclebmc.tex", "oraclebmc Documentation", + (master_doc, "oci.tex", "oci Documentation", "Oracle", "manual"), ] @@ -201,7 +201,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, "oraclebmc", "oraclebmc Documentation", + (master_doc, "oci", "oci Documentation", [author], 1) ] @@ -216,8 +216,8 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, "oraclebmc", "oraclebmc Documentation", - author, "oraclebmc", "One line description of project.", + (master_doc, "oci", "oci Documentation", + author, "oci", "One line description of project.", "Miscellaneous"), ] diff --git a/docs/configuration.rst b/docs/configuration.rst index 6bbd52145a..3ceb071fd1 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -1,28 +1,37 @@ .. _configuration: +.. raw:: html + + + Configuration ~~~~~~~~~~~~~ -oraclebmc uses a simple dict to build clients and other components. You can build these manually, or oraclebmc can +oci uses a simple dict to build clients and other components. You can build these manually, or oci can parse and validate a config file. -Using the default configuration location ``~/.oraclebmc/config`` you can use -:func:`config.from_file() ` to load any profile. By default, the ``DEFAULT`` profile +Using the default configuration location ``~/.oci/config`` you can use +:func:`config.from_file() ` to load any profile. By default, the ``DEFAULT`` profile is used: .. code-block:: pycon - >>> from oraclebmc.config import from_file + >>> from oci.config import from_file >>> config = from_file() # Using a different profile from the default location >>> config = from_file(profile_name="integ-beta") # Using the default profile from a different file - >>> config = from_file(file_location="~/.oraclebmc/config.prod") + >>> config = from_file(file_location="~/.oci/config.prod") Since ``config`` is a dict, you can also build it manually and check it with -:func:`config.validate_config() `: +:func:`config.validate_config() `: .. code-block:: python @@ -39,7 +48,7 @@ Since ``config`` is a dict, you can also build it manually and check it with "region": testrunner.region } - from oraclebmc.config import validate_config + from oci.config import validate_config validate_config(config) .. seealso:: diff --git a/docs/contributions.rst b/docs/contributions.rst index 46df2c4418..8e57c47593 100644 --- a/docs/contributions.rst +++ b/docs/contributions.rst @@ -1,5 +1,14 @@ .. _contributions: +.. raw:: html + + + Contributions ~~~~~~~~~~~~~~~~~~~~~~ -Got a fix for a bug, or a new feature you'd like to contribute? The SDK is open source and accepting pull requests on `GitHub `_. \ No newline at end of file +Got a fix for a bug, or a new feature you'd like to contribute? The SDK is open source and accepting pull requests on `GitHub `_. \ No newline at end of file diff --git a/docs/deprecation-notice.rst b/docs/deprecation-notice.rst new file mode 100644 index 0000000000..0b6dc5afd4 --- /dev/null +++ b/docs/deprecation-notice.rst @@ -0,0 +1,9 @@ +.. _deprecation-notice: + +Deprecation Notice +~~~~~~~~~~~~~~~~~~ + +.. warning:: + This domain is deprecated and will be removed in March 2018. + + Please access the documentation through our new location `here `_. \ No newline at end of file diff --git a/docs/feedback.rst b/docs/feedback.rst index eca7945ae0..4fb8616417 100644 --- a/docs/feedback.rst +++ b/docs/feedback.rst @@ -1,5 +1,13 @@ .. _feedback: +.. raw:: html + + Questions or Feedback ~~~~~~~~~~~~~~~~~~~~~~ @@ -8,15 +16,15 @@ Ways to get in touch: * `GitHub`_: To file bugs and feature requests only -* `Stack Overflow`_: Please use the `oracle-bmcs`_ and `oracle-bmcs-python-sdk`_ tags in your post +* `Stack Overflow`_: Please use the `oracle-cloud-infrastructure`_ and `oci-python-sdk`_ tags in your post * `Developer Tools section`_ of the Oracle Cloud forums * `My Oracle Support`_ -.. _GitHub: https://github.com/oracle/bmcs-python-sdk/issues +.. _GitHub: https://github.com/oracle/oci-python-sdk/issues .. _Stack Overflow: https://stackoverflow.com/ -.. _oracle-bmcs: https://stackoverflow.com/questions/tagged/oracle-bmcs -.. _oracle-bmcs-python-sdk: https://stackoverflow.com/questions/tagged/oracle-bmcs-python-sdk +.. _oracle-cloud-infrastructure: https://stackoverflow.com/questions/tagged/oracle-cloud-infrastructure +.. _oci-python-sdk: https://stackoverflow.com/questions/tagged/oci-python-sdk .. _Developer Tools section: https://community.oracle.com/community/cloud_computing/bare-metal/content?filterID=contentstatus[published]~category[developer-tools] .. _My Oracle Support: https://support.oracle.com/ \ No newline at end of file diff --git a/docs/forward-compatibility.rst b/docs/forward-compatibility.rst index e2785e247f..7956acf3d4 100644 --- a/docs/forward-compatibility.rst +++ b/docs/forward-compatibility.rst @@ -1,5 +1,14 @@ .. _forward-compatibility: +.. raw:: html + + + Forward Compatibility ~~~~~~~~~~~~~~~~~~~~~~ Some response fields are enum-typed. In the future, individual services may return values not covered by existing enums for that field. To address this possibility, every enum-type response field has an additional value named "UNKNOWN_ENUM_VALUE". If a service returns a value that is not recognized by your version of the SDK, then the response field will be set to this value. Please ensure that your code handles the "UNKNOWN_ENUM_VALUE" case if you have conditional logic based on an enum-typed field. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 2db71f0310..ba2a89bfcc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,25 @@ -Oracle BMCS Python SDK -~~~~~~~~~~~~~~~~~~~~~~ +.. raw:: html -This is the public Python SDK for Oracle Bare Metal Cloud Services. Python 2.7+ and 3.5+ are supported. + + +Oracle Cloud Infrastructure Python SDK +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This is the public Python SDK for Oracle Cloud Infrastructure. Python 2.7+ and 3.5+ are supported. .. code-block:: pycon - >>> import oraclebmc - >>> config = oraclebmc.config.from_file( - ... "~/.oraclebmc/config", + >>> import oci + >>> config = oci.config.from_file( + ... "~/.oci/config", ... "integ-beta-profile") - >>> identity = oraclebmc.identity.IdentityClient(config) + >>> identity = oci.identity.IdentityClient(config) >>> user = identity.get_user(config["user"]).data >>> print(user) { @@ -27,6 +36,8 @@ This is the public Python SDK for Oracle Bare Metal Cloud Services. Python 2.7+ To get started, head over to the :ref:`installation instructions ` or see more examples in the :ref:`quickstart ` section. +**Note**: The ``oraclebmc`` package is deprecated and will be removed in March 2018. Please check the :ref:`Backward Compatibility ` section if you are using ``oraclebmc``. + .. toctree:: :hidden: :maxdepth: 2 @@ -34,6 +45,7 @@ To get started, head over to the :ref:`installation instructions ` or s installation configuration forward-compatibility + backward-compatibility quickstart parallel-ops upload-manager diff --git a/docs/installation.rst b/docs/installation.rst index e1ec85f114..acb07d4c39 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,9 +1,18 @@ .. _install: +.. raw:: html + + + Installation ~~~~~~~~~~~~ -This topic describes how to install, configure, and use the Oracle Bare Metal Cloud Services Python SDK. +This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Python SDK. The Python SDK supports operations for the following services: * Identity and Access Management Service @@ -14,12 +23,12 @@ The Python SDK supports operations for the following services: Prerequisites =============== -* An Oracle Bare Metal Cloud Services account +* An Oracle Cloud Infrastructure account * A user created in that account, in a group with a policy that grants the desired permissions. This can be a user for yourself, or another person/system that needs to call the API. For an example of how to set up a new user, group, compartment, and policy, see `Adding Users`_ in the Getting Started Guide. For a list of other typical - Oracle Bare Metal Cloud Services policies, see `Common Policies`_ in the User Guide. + Oracle Cloud Infrastructure policies, see `Common Policies`_ in the User Guide. * Python version 2.7.5 or 3.5 or later, running on Mac, Windows, or Linux. * The Python SDK uses the `cryptography.io`_ library, which has its own additional `build requirements`_. * A keypair used for signing API requests, with the public key uploaded to Oracle. Only the user calling @@ -34,22 +43,22 @@ You can install the Python SDK through the Python Package Index (PyPI), or alter **PyPi** -To install from `PyPI `_: +To install from `PyPI `_: Use the following command:: - pip install oraclebmc + pip install oci **GitHub** To install from GitHub: -1. Download the SDK from `GitHub `_. +1. Download the SDK from `GitHub `_. The download is a zip containing a whl file and documentation. 2. Extract the files from the zip. 3. Use the following command to install the SDK:: - pip install oraclebmc-*-py2.py3-none-any.whl + pip install oci-*-py2.py3-none-any.whl .. note:: @@ -70,8 +79,8 @@ Although optional, Oracle recommends that you run the SDK in a virtual environme For example:: - virtualenv bmcs_sdk_env - . bmcs_sdk_env/bin/activate + virtualenv oci_sdk_env + . oci_sdk_env/bin/activate @@ -114,7 +123,7 @@ You might encounter issues when installing Python or the SDK, or using the SDK i Service Errors -------------- -Any operation resulting in a service error will cause an exception of type oraclebmc.exceptions.ServiceError to be thrown by the SDK. For information about common service errors returned by BMCS, see `API Errors `_ +Any operation resulting in a service error will cause an exception of type oci.exceptions.ServiceError to be thrown by the SDK. For information about common service errors returned by OCI, see `API Errors `_ . SSL/TLS or Certificate Issues diff --git a/docs/license.rst b/docs/license.rst index bdc6f567f9..d42735b175 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -1,3 +1,12 @@ +.. raw:: html + + + License ~~~~~~~ diff --git a/docs/notifications.rst b/docs/notifications.rst index 433eb6145c..3a96a7dd91 100644 --- a/docs/notifications.rst +++ b/docs/notifications.rst @@ -1,7 +1,16 @@ .. _notifications: +.. raw:: html + + + Notifications ~~~~~~~~~~~~~~~~~~~~~~ To be notified when a new version of the Python SDK is released, subscribe to the `Atom feed`_. -.. _Atom feed: https://github.com/oracle/bmcs-python-sdk/releases.atom \ No newline at end of file +.. _Atom feed: https://github.com/oracle/oci-python-sdk/releases.atom \ No newline at end of file diff --git a/docs/parallel-ops.rst b/docs/parallel-ops.rst index eb258480e8..125c55e823 100644 --- a/docs/parallel-ops.rst +++ b/docs/parallel-ops.rst @@ -1,5 +1,14 @@ .. _parallel-ops: +.. raw:: html + + + Parallel Operations ~~~~~~~~~~~~~~~~~~~~~~ -The Python SDK supports parallel requests to Oracle Bare Metal Cloud Services. For example, the `object storage upload `_ example shows how multiple processes can be used to upload files to object storage. \ No newline at end of file +The Python SDK supports parallel requests to Oracle Cloud Infrastructure. For example, the `object storage upload `_ example shows how multiple processes can be used to upload files to object storage. \ No newline at end of file diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 0fb1e36911..fae6eab14c 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -1,5 +1,14 @@ .. _quickstart: +.. raw:: html + + + Quickstart ~~~~~~~~~~ @@ -7,7 +16,7 @@ Clients only require a valid config object: .. code-block:: pycon - >>> from oraclebmc.identity import IdentityClient + >>> from oci.identity import IdentityClient >>> identity = IdentityClient(config) ================================ @@ -23,22 +32,22 @@ Let's create a new user and group, and add the user to the group. Then we'll li finally clean up the user and group we created. First, we'll need to create a valid config object and service client. If you haven't set up a config file, head over -to the :ref:`Configuration ` section to create one. We'll use the default location ``~/.oraclebmc/config`` +to the :ref:`Configuration ` section to create one. We'll use the default location ``~/.oci/config`` and default profile name ``DEFAULT`` to create an Identity client. Since we'll be using the root compartment (or tenancy) for most operations, let's also extract that from the config object: .. code-block:: pycon - >>> import oraclebmc - >>> config = oraclebmc.config.from_file() - >>> identity = oraclebmc.identity.IdentityClient(config) + >>> import oci + >>> config = oci.config.from_file() + >>> identity = oci.identity.IdentityClient(config) >>> compartment_id = config["tenancy"] Next we'll need to populate an instance of the ``CreateGroupDetails`` model with our request, and then send it: .. code-block:: pycon - >>> from oraclebmc.identity.models import CreateGroupDetails + >>> from oci.identity.models import CreateGroupDetails >>> request = CreateGroupDetails() >>> request.compartment_id = compartment_id >>> request.name = "my-test-group" @@ -53,7 +62,7 @@ Creating a user is very similar: .. code-block:: pycon - >>> from oraclebmc.identity.models import CreateUserDetails + >>> from oci.identity.models import CreateUserDetails >>> request = CreateUserDetails() >>> request.compartment_id = compartment_id >>> request.name = "my-test-user" @@ -66,7 +75,7 @@ Using the ids from the ``group`` and ``user`` above, we can add the user to the .. code-block:: pycon - >>> from oraclebmc.identity.models import AddUserToGroupDetails + >>> from oci.identity.models import AddUserToGroupDetails >>> request = AddUserToGroupDetails() >>> request.group_id = group.data.id >>> request.user_id = user.data.id @@ -163,14 +172,14 @@ When using object storage, you'll need to provide a namespace, in addition to yo .. code-block:: pycon - >>> object_storage = oraclebmc.object_storage.ObjectStorageClient(config) + >>> object_storage = oci.object_storage.ObjectStorageClient(config) >>> namespace = object_storage.get_namespace().data To upload an object, we'll create a bucket: .. code-block:: pycon - >>> from oraclebmc.object_storage.models import CreateBucketDetails + >>> from oci.object_storage.models import CreateBucketDetails >>> request = CreateBucketDetails() >>> request.compartment_id = compartment_id >>> request.name = "MyTestBucket" @@ -207,7 +216,7 @@ And to get it back: ============ Next, head to the `User Guides`_ or jump right into the :ref:`API Reference ` -to explore the available operations for each service, and their parameters. Additional Python examples can be found on `GitHub `_. +to explore the available operations for each service, and their parameters. Additional Python examples can be found on `GitHub `_. .. note:: diff --git a/docs/raw-requests.rst b/docs/raw-requests.rst index 4e8572c06e..d6ef35cb2d 100644 --- a/docs/raw-requests.rst +++ b/docs/raw-requests.rst @@ -1,33 +1,42 @@ +.. raw:: html + + + Raw Requests ~~~~~~~~~~~~ The Python SDK exposes a custom :class:`requests.auth.AuthBase` which you can use to sign non-standard calls. -This can be helpful if you need to make a BMCS- authenticated request to an alternate endpoint or to a -BMCS API not yet supported in the SDK. +This can be helpful if you need to make a OCI- authenticated request to an alternate endpoint or to a +OCI API not yet supported in the SDK. =================== Creating a Signer =================== Constructing a Signer instance requires a few pieces of information. By default, the SDK uses the values in -the config file at ``~/.oraclebmc/config``. You can manually specify the required fields, or use a config loader +the config file at ``~/.oci/config``. You can manually specify the required fields, or use a config loader to pull in the values from a file: .. code-block:: python - from oraclebmc.signer import Signer + from oci.signer import Signer auth = Signer( tenancy='ocid1.tenancy.oc1..aaaaaaaa[...]', user='ocid1.user.oc1..aaaaaaaa[...]', fingerprint='20:3b:97:13:55:1c:[...]', - private_key_file_location='~/.oraclebmc/bmcs_api_key.pem', + private_key_file_location='~/.oci/oci_api_key.pem', pass_phrase='hunter2' # optional ) # Or load directly from a file - from oraclebmc.config import from_file - config = from_file('~/.oraclebmc/config') + from oci.config import from_file + config = from_file('~/.oci/config') auth = Signer( tenancy=config['tenancy'], user=config['user'], diff --git a/docs/upload-manager.rst b/docs/upload-manager.rst index 438e42502f..e60b60f380 100644 --- a/docs/upload-manager.rst +++ b/docs/upload-manager.rst @@ -1,8 +1,17 @@ .. _upload-manager: +.. raw:: html + + + Uploading Large Objects ~~~~~~~~~~~~~~~~~~~~~~~~ The Object Storage service supports multipart uploads to make large object uploads easier by splitting the large object into parts. The Python SDK supports raw multipart upload operations for advanced use cases, as well as a higher-level upload class that uses the multipart upload APIs. `Managing Multipart Uploads `_ provides links to the APIs used for raw multipart upload operations. Higher-level uploads can be performed using the UploadManager. The UploadManger will: split a large object into parts for you, upload the parts in parallel, and then recombine and commit the parts as a single object in Object Storage. -The `UploadObject `_ example shows how UploadManager can be used to upload files to object storage. \ No newline at end of file +The `UploadObject `_ example shows how UploadManager can be used to upload files to object storage. \ No newline at end of file diff --git a/examples/multipart_object_upload.py b/examples/multipart_object_upload.py index ea27fb2fb6..a0c4daf4df 100644 --- a/examples/multipart_object_upload.py +++ b/examples/multipart_object_upload.py @@ -2,19 +2,19 @@ from __future__ import print_function import os -import oraclebmc -from oraclebmc.object_storage import UploadManager -from oraclebmc.object_storage.models import CreateBucketDetails -from oraclebmc.object_storage.transfer.constants import MEBIBYTE +import oci +from oci.object_storage import UploadManager +from oci.object_storage.models import CreateBucketDetails +from oci.object_storage.transfer.constants import MEBIBYTE def progress_callback(bytes_uploaded): print("{} additional bytes uploaded".format(bytes_uploaded)) -config = oraclebmc.config.from_file() +config = oci.config.from_file() compartment_id = config["tenancy"] -object_storage = oraclebmc.object_storage.ObjectStorageClient(config) +object_storage = oci.object_storage.ObjectStorageClient(config) namespace = object_storage.get_namespace().data bucket_name = "python-sdk-example-bucket" diff --git a/examples/object_crud.py b/examples/object_crud.py index 932cd0beb4..5f62313023 100644 --- a/examples/object_crud.py +++ b/examples/object_crud.py @@ -1,12 +1,12 @@ # Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. -import oraclebmc -from oraclebmc.object_storage.models import CreateBucketDetails +import oci +from oci.object_storage.models import CreateBucketDetails -config = oraclebmc.config.from_file() +config = oci.config.from_file() compartment_id = config["tenancy"] -object_storage = oraclebmc.object_storage.ObjectStorageClient(config) +object_storage = oci.object_storage.ObjectStorageClient(config) namespace = object_storage.get_namespace().data bucket_name = "python-sdk-example-bucket" diff --git a/examples/pagination.py b/examples/pagination.py index d564598e2c..2041ecac38 100644 --- a/examples/pagination.py +++ b/examples/pagination.py @@ -1,11 +1,11 @@ # Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. -import oraclebmc +import oci -config = oraclebmc.config.from_file() +config = oci.config.from_file() compartment_id = config["tenancy"] -identity = oraclebmc.identity.IdentityClient(config) +identity = oci.identity.IdentityClient(config) # operation-independent pagination function diff --git a/examples/parallel_upload_to_object_storage.py b/examples/parallel_upload_to_object_storage.py index 1af125c0e9..426b8ac33f 100644 --- a/examples/parallel_upload_to_object_storage.py +++ b/examples/parallel_upload_to_object_storage.py @@ -8,7 +8,7 @@ # Loads configuration from default profile in the default config # file -import oraclebmc +import oci import os import argparse from multiprocessing import Process @@ -30,7 +30,7 @@ def upload_to_object_storage(config, namespace, bucket, path): """ with open(path, "rb") as in_file: name = os.path.basename(path) - ostorage = oraclebmc.object_storage.ObjectStorageClient(config) + ostorage = oci.object_storage.ObjectStorageClient(config) ostorage.put_object(namespace, bucket, name, @@ -39,8 +39,8 @@ def upload_to_object_storage(config, namespace, bucket, path): if __name__ == "__main__": - config = oraclebmc.config.from_file() - object_storage = oraclebmc.object_storage.ObjectStorageClient(config) + config = oci.config.from_file() + object_storage = oci.object_storage.ObjectStorageClient(config) namespace = object_storage.get_namespace().data description = "\n".join(["This is an example to show how multiple files can be uploaded to in", diff --git a/examples/raw_request.py b/examples/raw_request.py index 3be3748d48..f2be717547 100644 --- a/examples/raw_request.py +++ b/examples/raw_request.py @@ -1,10 +1,10 @@ # Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. import requests -from oraclebmc.config import from_file -from oraclebmc.signer import Signer +from oci.config import from_file +from oci.signer import Signer -config = from_file('~/.oraclebmc/config') +config = from_file() auth = Signer( tenancy=config['tenancy'], user=config['user'], diff --git a/examples/user_crud.py b/examples/user_crud.py index 38d91685c3..6073403845 100644 --- a/examples/user_crud.py +++ b/examples/user_crud.py @@ -1,13 +1,13 @@ # Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. -import oraclebmc -from oraclebmc.identity.models import AddUserToGroupDetails, CreateGroupDetails, CreateUserDetails +import oci +from oci.identity.models import AddUserToGroupDetails, CreateGroupDetails, CreateUserDetails # Default config file and profile -config = oraclebmc.config.from_file() +config = oci.config.from_file() compartment_id = config["tenancy"] # Service client -identity = oraclebmc.identity.IdentityClient(config) +identity = oci.identity.IdentityClient(config) user_name = "python-sdk-example-user" diff --git a/setup.py b/setup.py index ea713340f7..bf95c4cc34 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ def open_relative(*path): return io.open(filename, mode="r", encoding="utf-8") -with open_relative("src", "oraclebmc", "version.py") as fd: +with open_relative("src", "oci", "version.py") as fd: version = re.search( r"^__version__\s*=\s*['\"]([^'\"]*)['\"]", fd.read(), re.MULTILINE).group(1) @@ -40,10 +40,10 @@ def open_relative(*path): ] setup( - name="oraclebmc", - url="https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/index.html", + name="oci", + url="http://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/index.html", version=version, - description="Oracle Bare Metal Cloud Services Python SDK", + description="Oracle Cloud Infrastructure Python SDK", long_description=readme, author="Oracle", author_email="joe.levy@oracle.com", diff --git a/src/oraclebmc/__init__.py b/src/oci/__init__.py similarity index 59% rename from src/oraclebmc/__init__.py rename to src/oci/__init__.py index ba89b779c7..45f6f900e8 100644 --- a/src/oraclebmc/__init__.py +++ b/src/oci/__init__.py @@ -1,7 +1,7 @@ # coding: utf-8 # Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. -from . import config, constants, core, exceptions, identity, load_balancer, object_storage, regions +from . import config, constants, core, database, exceptions, identity, load_balancer, object_storage, regions from .base_client import BaseClient from .request import Request from .response import Response @@ -12,6 +12,7 @@ __all__ = [ "BaseClient", "Error", "Request", "Response", "Signer", - "config", "constants", "core", "exceptions", "identity", - "load_balancer", "object_storage", "regions", "wait_until" + "config", "constants", "core", "database", "exceptions", + "identity", "load_balancer", "object_storage", "regions", + "wait_until" ] diff --git a/src/oraclebmc/base_client.py b/src/oci/base_client.py similarity index 100% rename from src/oraclebmc/base_client.py rename to src/oci/base_client.py diff --git a/src/oraclebmc/config.py b/src/oci/config.py similarity index 79% rename from src/oraclebmc/config.py rename to src/oci/config.py index 58b23fa9e1..a6ba4ceacf 100644 --- a/src/oraclebmc/config.py +++ b/src/oci/config.py @@ -38,7 +38,8 @@ "additional_user_agent": "", "pass_phrase": None } -DEFAULT_LOCATION = os.path.join('~', '.oraclebmc', 'config') +DEFAULT_LOCATION = os.path.join('~', '.oci', 'config') +FALLBACK_DEFAULT_LOCATION = os.path.join('~', '.oraclebmc', 'config') DEFAULT_PROFILE = "DEFAULT" PATTERNS = { # Tenancy and user have the same shape @@ -58,18 +59,23 @@ def from_file(file_location=DEFAULT_LOCATION, profile_name=DEFAULT_PROFILE): """Create a config dict from a file. - :param file_location: Path to the config file. Defaults to ~/.oraclebmc/config + :param file_location: Path to the config file. Defaults to ~/.oci/config and with a fallback to ~/.oraclebmc/config. :param profile_name: The profile to load from the config file. Defaults to "DEFAULT" :return: A config dict that can be used to create clients. """ - file_location = os.path.expanduser(file_location) + expanded_file_location = os.path.expanduser(file_location) + expanded_fallback_default_file_location = os.path.expanduser(FALLBACK_DEFAULT_LOCATION) + + # if there is no file in the default location (~/.oci/config), and the fallback file does exist, use the fallback (~/.oraclebmc/config) + if file_location == DEFAULT_LOCATION and not os.path.isfile(expanded_file_location) and os.path.isfile(expanded_fallback_default_file_location): + expanded_file_location = expanded_fallback_default_file_location parser = configparser.ConfigParser(interpolation=None) - if not parser.read(file_location): - raise ConfigFileNotFound("Could not find config file at {}".format(file_location)) + if not parser.read(expanded_file_location): + raise ConfigFileNotFound("Could not find config file at {}".format(expanded_file_location)) if profile_name not in parser: - raise ProfileNotFound("Profile '{}' not found in config file {}".format(profile_name, file_location)) + raise ProfileNotFound("Profile '{}' not found in config file {}".format(profile_name, expanded_file_location)) config = dict(DEFAULT_CONFIG) config.update(parser[profile_name]) diff --git a/src/oraclebmc/constants.py b/src/oci/constants.py similarity index 100% rename from src/oraclebmc/constants.py rename to src/oci/constants.py diff --git a/src/oraclebmc/core/__init__.py b/src/oci/core/__init__.py similarity index 100% rename from src/oraclebmc/core/__init__.py rename to src/oci/core/__init__.py diff --git a/src/oraclebmc/core/blockstorage_client.py b/src/oci/core/blockstorage_client.py similarity index 91% rename from src/oraclebmc/core/blockstorage_client.py rename to src/oci/core/blockstorage_client.py index 47b9562305..3cb8cb3980 100644 --- a/src/oraclebmc/core/blockstorage_client.py +++ b/src/oci/core/blockstorage_client.py @@ -55,12 +55,12 @@ def create_volume(self, create_volume_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Volume` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Volume` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumes" method = "POST" @@ -107,12 +107,12 @@ def create_volume_backup(self, create_volume_backup_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VolumeBackup` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeBackup` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumeBackups" method = "POST" @@ -159,8 +159,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumes/{volumeId}" method = "DELETE" @@ -206,8 +206,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumeBackups/{volumeBackupId}" method = "DELETE" @@ -248,8 +248,8 @@ def get_volume(self, volume_id, **kwargs): :param str volume_id: (required) The OCID of the volume. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Volume` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Volume` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumes/{volumeId}" method = "GET" @@ -284,8 +284,8 @@ def get_volume_backup(self, volume_backup_id, **kwargs): :param str volume_backup_id: (required) The OCID of the volume backup. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VolumeBackup` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeBackup` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumeBackups/{volumeBackupId}" method = "GET" @@ -331,8 +331,8 @@ def list_volume_backups(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.VolumeBackup` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VolumeBackup` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumeBackups" method = "GET" @@ -390,8 +390,8 @@ def list_volumes(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.Volume` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Volume` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumes" method = "GET" @@ -445,8 +445,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Volume` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Volume` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumes/{volumeId}" method = "PUT" @@ -498,8 +498,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VolumeBackup` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeBackup` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumeBackups/{volumeBackupId}" method = "PUT" diff --git a/src/oraclebmc/core/compute_client.py b/src/oci/core/compute_client.py similarity index 82% rename from src/oraclebmc/core/compute_client.py rename to src/oci/core/compute_client.py index 7a1e1224cb..0c2214eeb7 100644 --- a/src/oraclebmc/core/compute_client.py +++ b/src/oci/core/compute_client.py @@ -31,7 +31,7 @@ def attach_vnic(self, attach_vnic_details, **kwargs): AttachVnic Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see - `Managing Virtual Network Interface Cards (VNICs)`__. + `Virtual Network Interface Cards (VNICs)`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm @@ -42,12 +42,12 @@ def attach_vnic(self, attach_vnic_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VnicAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VnicAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/vnicAttachments/" method = "POST" @@ -87,12 +87,12 @@ def attach_volume(self, attach_volume_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VolumeAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumeAttachments/" method = "POST" @@ -148,12 +148,12 @@ def capture_console_history(self, capture_console_history_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.ConsoleHistory` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.ConsoleHistory` + :rtype: :class:`~oci.response.Response` """ resource_path = "/instanceConsoleHistories/" method = "POST" @@ -220,12 +220,12 @@ def create_image(self, create_image_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Image` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Image` + :rtype: :class:`~oci.response.Response` """ resource_path = "/images/" method = "POST" @@ -253,6 +253,51 @@ def create_image(self, create_image_details, **kwargs): body=create_image_details, response_type="Image") + def create_instance_console_connection(self, create_instance_console_connection_details, **kwargs): + """ + CreateInstanceConsoleConnection + Create a console connection for an instance. + + + :param CreateInstanceConsoleConnectionDetails create_instance_console_connection_details: (required) + Request object for creating an InstanceConsoleConnection + + :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 (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InstanceConsoleConnection` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/instanceConsoleConnections/" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "opc_retry_token" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_instance_console_connection got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "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} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_instance_console_connection_details, + response_type="InstanceConsoleConnection") + def delete_console_history(self, instance_console_history_id, **kwargs): """ DeleteConsoleHistory @@ -267,8 +312,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/instanceConsoleHistories/{instanceConsoleHistoryId}" method = "DELETE" @@ -314,8 +359,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/images/{imageId}" method = "DELETE" @@ -347,6 +392,53 @@ def delete_image(self, image_id, **kwargs): path_params=path_params, header_params=header_params) + def delete_instance_console_connection(self, instance_console_connection_id, **kwargs): + """ + DeleteInstanceConsoleConnection + Delete the console connection for an instance + + + :param str instance_console_connection_id: (required) + The OCID of the intance console connection + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/instanceConsoleConnections/{instanceConsoleConnectionId}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "if_match" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_instance_console_connection got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "instanceConsoleConnectionId": instance_console_connection_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + def detach_vnic(self, vnic_attachment_id, **kwargs): """ DetachVnic @@ -364,8 +456,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/vnicAttachments/{vnicAttachmentId}" method = "DELETE" @@ -402,7 +494,7 @@ def detach_volume(self, volume_attachment_id, **kwargs): DetachVolume Detaches a storage volume from an instance. You must specify the OCID of the volume attachment. - This is an asynchronous operation; the attachment's `lifecycleState` will change to DETACHING temporarily + This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed. @@ -414,8 +506,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumeAttachments/{volumeAttachmentId}" method = "DELETE" @@ -476,7 +568,7 @@ def export_image(self, image_id, export_image_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). @@ -485,8 +577,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Image` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Image` + :rtype: :class:`~oci.response.Response` """ resource_path = "/images/{imageId}/actions/export" method = "POST" @@ -533,8 +625,8 @@ def get_console_history(self, instance_console_history_id, **kwargs): :param str instance_console_history_id: (required) The OCID of the console history. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.ConsoleHistory` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.ConsoleHistory` + :rtype: :class:`~oci.response.Response` """ resource_path = "/instanceConsoleHistories/{instanceConsoleHistoryId}" method = "GET" @@ -577,8 +669,8 @@ def get_console_history_content(self, instance_console_history_id, **kwargs): :param int length: (optional) Length of the snapshot data to retrieve. - :return: A :class:`~oraclebmc.response.Response` object with data of type bytes - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type bytes + :rtype: :class:`~oci.response.Response` """ resource_path = "/instanceConsoleHistories/{instanceConsoleHistoryId}/data" method = "GET" @@ -626,8 +718,8 @@ def get_image(self, image_id, **kwargs): :param str image_id: (required) The OCID of the image. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Image` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Image` + :rtype: :class:`~oci.response.Response` """ resource_path = "/images/{imageId}" method = "GET" @@ -662,8 +754,8 @@ def get_instance(self, instance_id, **kwargs): :param str instance_id: (required) The OCID of the instance. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Instance` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Instance` + :rtype: :class:`~oci.response.Response` """ resource_path = "/instances/{instanceId}" method = "GET" @@ -689,6 +781,42 @@ def get_instance(self, instance_id, **kwargs): header_params=header_params, response_type="Instance") + def get_instance_console_connection(self, instance_console_connection_id, **kwargs): + """ + GetInstanceConsoleConnection + Get the details of an instance console connection + + + :param str instance_console_connection_id: (required) + The OCID of the intance console connection + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InstanceConsoleConnection` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/instanceConsoleConnections/{instanceConsoleConnectionId}" + method = "GET" + + if kwargs: + raise ValueError( + "get_instance_console_connection got unknown kwargs: {!r}".format(kwargs)) + + path_params = { + "instanceConsoleConnectionId": instance_console_connection_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="InstanceConsoleConnection") + def get_vnic_attachment(self, vnic_attachment_id, **kwargs): """ GetVnicAttachment @@ -698,8 +826,8 @@ def get_vnic_attachment(self, vnic_attachment_id, **kwargs): :param str vnic_attachment_id: (required) The OCID of the VNIC attachment. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VnicAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VnicAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/vnicAttachments/{vnicAttachmentId}" method = "GET" @@ -734,8 +862,8 @@ def get_volume_attachment(self, volume_attachment_id, **kwargs): :param str volume_attachment_id: (required) The OCID of the volume attachment. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VolumeAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VolumeAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumeAttachments/{volumeAttachmentId}" method = "GET" @@ -771,8 +899,8 @@ def get_windows_instance_initial_credentials(self, instance_id, **kwargs): :param str instance_id: (required) The OCID of the instance. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.InstanceCredentials` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InstanceCredentials` + :rtype: :class:`~oci.response.Response` """ resource_path = "/instances/{instanceId}/initialCredentials" method = "GET" @@ -828,7 +956,7 @@ def instance_action(self, instance_id, action, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). @@ -837,8 +965,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Instance` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Instance` + :rtype: :class:`~oci.response.Response` """ resource_path = "/instances/{instanceId}" method = "POST" @@ -910,7 +1038,7 @@ def launch_instance(self, launch_instance_details, **kwargs): :func:`get_vnic` with the VNIC ID. You can later add secondary VNICs to an instance. For more information, see - `Managing Virtual Network Interface Cards (VNICs)`__. + `Virtual Network Interface Cards (VNICs)`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm @@ -924,12 +1052,12 @@ def launch_instance(self, launch_instance_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Instance` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Instance` + :rtype: :class:`~oci.response.Response` """ resource_path = "/instances/" method = "POST" @@ -982,8 +1110,8 @@ def list_console_histories(self, compartment_id, **kwargs): :param str instance_id: (optional) The OCID of the instance. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.ConsoleHistory` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.ConsoleHistory` + :rtype: :class:`~oci.response.Response` """ resource_path = "/instanceConsoleHistories/" method = "GET" @@ -1058,8 +1186,8 @@ def list_images(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.Image` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Image` + :rtype: :class:`~oci.response.Response` """ resource_path = "/images/" method = "GET" @@ -1099,6 +1227,63 @@ def list_images(self, compartment_id, **kwargs): header_params=header_params, response_type="list[Image]") + def list_instance_console_connections(self, compartment_id, **kwargs): + """ + ListInstanceConsoleConnections + Lists the console connections for the specified compartment or instance that have not been deleted. + + + :param str compartment_id: (required) + The OCID of the compartment. + + :param str instance_id: (optional) + The OCID of the instance. + + :param int limit: (optional) + The maximum number of items to return in a paginated \"List\" call. + + Example: `500` + + :param str page: (optional) + The value of the `opc-next-page` response header from the previous \"List\" call. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.InstanceConsoleConnection` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/instanceConsoleConnections/" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "instance_id", + "limit", + "page" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_instance_console_connections got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "compartmentId": compartment_id, + "instanceId": kwargs.get("instance_id", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[InstanceConsoleConnection]") + def list_instances(self, compartment_id, **kwargs): """ ListInstances @@ -1129,8 +1314,8 @@ def list_instances(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.Instance` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Instance` + :rtype: :class:`~oci.response.Response` """ resource_path = "/instances/" method = "GET" @@ -1194,8 +1379,8 @@ def list_shapes(self, compartment_id, **kwargs): :param str image_id: (optional) The OCID of an image. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.Shape` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Shape` + :rtype: :class:`~oci.response.Response` """ resource_path = "/shapes" method = "GET" @@ -1263,8 +1448,8 @@ def list_vnic_attachments(self, compartment_id, **kwargs): :param str vnic_id: (optional) The OCID of the VNIC. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.VnicAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VnicAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/vnicAttachments/" method = "GET" @@ -1335,8 +1520,8 @@ def list_volume_attachments(self, compartment_id, **kwargs): :param str volume_id: (optional) The OCID of the volume. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.VolumeAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VolumeAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/volumeAttachments/" method = "GET" @@ -1382,7 +1567,7 @@ def terminate_instance(self, instance_id, **kwargs): Terminates the specified instance. Any attached VNICs and volumes are automatically detached when the instance terminates. - This is an asynchronous operation; the instance's `lifecycleState` will change to TERMINATING temporarily + This is an asynchronous operation. The instance's `lifecycleState` will change to TERMINATING temporarily until the instance is completely removed. @@ -1394,8 +1579,8 @@ def terminate_instance(self, instance_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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/instances/{instanceId}" method = "DELETE" @@ -1442,7 +1627,7 @@ def update_image(self, image_id, update_image_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). @@ -1451,8 +1636,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Image` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Image` + :rtype: :class:`~oci.response.Response` """ resource_path = "/images/{imageId}" method = "PUT" @@ -1504,7 +1689,7 @@ def update_instance(self, instance_id, update_instance_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). @@ -1513,8 +1698,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Instance` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Instance` + :rtype: :class:`~oci.response.Response` """ resource_path = "/instances/{instanceId}" method = "PUT" diff --git a/src/oraclebmc/core/models/__init__.py b/src/oci/core/models/__init__.py similarity index 96% rename from src/oraclebmc/core/models/__init__.py rename to src/oci/core/models/__init__.py index 59f6208432..9a05966502 100644 --- a/src/oraclebmc/core/models/__init__.py +++ b/src/oci/core/models/__init__.py @@ -17,6 +17,7 @@ from .create_drg_details import CreateDrgDetails from .create_ip_sec_connection_details import CreateIPSecConnectionDetails from .create_image_details import CreateImageDetails +from .create_instance_console_connection_details import CreateInstanceConsoleConnectionDetails from .create_internet_gateway_details import CreateInternetGatewayDetails from .create_private_ip_details import CreatePrivateIpDetails from .create_route_table_details import CreateRouteTableDetails @@ -55,6 +56,7 @@ from .image_source_via_object_storage_uri_details import ImageSourceViaObjectStorageUriDetails from .ingress_security_rule import IngressSecurityRule from .instance import Instance +from .instance_console_connection import InstanceConsoleConnection from .instance_credentials import InstanceCredentials from .internet_gateway import InternetGateway from .launch_instance_details import LaunchInstanceDetails @@ -114,6 +116,7 @@ "CreateDrgDetails": CreateDrgDetails, "CreateIPSecConnectionDetails": CreateIPSecConnectionDetails, "CreateImageDetails": CreateImageDetails, + "CreateInstanceConsoleConnectionDetails": CreateInstanceConsoleConnectionDetails, "CreateInternetGatewayDetails": CreateInternetGatewayDetails, "CreatePrivateIpDetails": CreatePrivateIpDetails, "CreateRouteTableDetails": CreateRouteTableDetails, @@ -152,6 +155,7 @@ "ImageSourceViaObjectStorageUriDetails": ImageSourceViaObjectStorageUriDetails, "IngressSecurityRule": IngressSecurityRule, "Instance": Instance, + "InstanceConsoleConnection": InstanceConsoleConnection, "InstanceCredentials": InstanceCredentials, "InternetGateway": InternetGateway, "LaunchInstanceDetails": LaunchInstanceDetails, diff --git a/src/oraclebmc/core/models/attach_i_scsi_volume_details.py b/src/oci/core/models/attach_i_scsi_volume_details.py similarity index 100% rename from src/oraclebmc/core/models/attach_i_scsi_volume_details.py rename to src/oci/core/models/attach_i_scsi_volume_details.py diff --git a/src/oraclebmc/core/models/attach_vnic_details.py b/src/oci/core/models/attach_vnic_details.py similarity index 100% rename from src/oraclebmc/core/models/attach_vnic_details.py rename to src/oci/core/models/attach_vnic_details.py diff --git a/src/oraclebmc/core/models/attach_volume_details.py b/src/oci/core/models/attach_volume_details.py similarity index 100% rename from src/oraclebmc/core/models/attach_volume_details.py rename to src/oci/core/models/attach_volume_details.py diff --git a/src/oraclebmc/core/models/capture_console_history_details.py b/src/oci/core/models/capture_console_history_details.py similarity index 100% rename from src/oraclebmc/core/models/capture_console_history_details.py rename to src/oci/core/models/capture_console_history_details.py diff --git a/src/oraclebmc/core/models/console_history.py b/src/oci/core/models/console_history.py similarity index 100% rename from src/oraclebmc/core/models/console_history.py rename to src/oci/core/models/console_history.py diff --git a/src/oraclebmc/core/models/cpe.py b/src/oci/core/models/cpe.py similarity index 97% rename from src/oraclebmc/core/models/cpe.py rename to src/oci/core/models/cpe.py index 45501e45bc..9824879808 100644 --- a/src/oraclebmc/core/models/cpe.py +++ b/src/oci/core/models/cpe.py @@ -109,7 +109,7 @@ def id(self, id): def ip_address(self): """ Gets the ip_address of this Cpe. - The public IP address of the on-premise router. + The public IP address of the on-premises router. :return: The ip_address of this Cpe. @@ -121,7 +121,7 @@ def ip_address(self): def ip_address(self, ip_address): """ Sets the ip_address of this Cpe. - The public IP address of the on-premise router. + The public IP address of the on-premises router. :param ip_address: The ip_address of this Cpe. diff --git a/src/oraclebmc/core/models/create_cpe_details.py b/src/oci/core/models/create_cpe_details.py similarity index 96% rename from src/oraclebmc/core/models/create_cpe_details.py rename to src/oci/core/models/create_cpe_details.py index fdac087a34..38eee738bc 100644 --- a/src/oraclebmc/core/models/create_cpe_details.py +++ b/src/oci/core/models/create_cpe_details.py @@ -77,7 +77,7 @@ def display_name(self, display_name): def ip_address(self): """ Gets the ip_address of this CreateCpeDetails. - The public IP address of the on-premise router. + The public IP address of the on-premises router. Example: `143.19.23.16` @@ -91,7 +91,7 @@ def ip_address(self): def ip_address(self, ip_address): """ Sets the ip_address of this CreateCpeDetails. - The public IP address of the on-premise router. + The public IP address of the on-premises router. Example: `143.19.23.16` diff --git a/src/oraclebmc/core/models/create_cross_connect_details.py b/src/oci/core/models/create_cross_connect_details.py similarity index 100% rename from src/oraclebmc/core/models/create_cross_connect_details.py rename to src/oci/core/models/create_cross_connect_details.py diff --git a/src/oraclebmc/core/models/create_cross_connect_group_details.py b/src/oci/core/models/create_cross_connect_group_details.py similarity index 100% rename from src/oraclebmc/core/models/create_cross_connect_group_details.py rename to src/oci/core/models/create_cross_connect_group_details.py diff --git a/src/oraclebmc/core/models/create_dhcp_details.py b/src/oci/core/models/create_dhcp_details.py similarity index 100% rename from src/oraclebmc/core/models/create_dhcp_details.py rename to src/oci/core/models/create_dhcp_details.py diff --git a/src/oraclebmc/core/models/create_drg_attachment_details.py b/src/oci/core/models/create_drg_attachment_details.py similarity index 100% rename from src/oraclebmc/core/models/create_drg_attachment_details.py rename to src/oci/core/models/create_drg_attachment_details.py diff --git a/src/oraclebmc/core/models/create_drg_details.py b/src/oci/core/models/create_drg_details.py similarity index 100% rename from src/oraclebmc/core/models/create_drg_details.py rename to src/oci/core/models/create_drg_details.py diff --git a/src/oraclebmc/core/models/create_image_details.py b/src/oci/core/models/create_image_details.py similarity index 100% rename from src/oraclebmc/core/models/create_image_details.py rename to src/oci/core/models/create_image_details.py diff --git a/src/oci/core/models/create_instance_console_connection_details.py b/src/oci/core/models/create_instance_console_connection_details.py new file mode 100644 index 0000000000..039a49bcb4 --- /dev/null +++ b/src/oci/core/models/create_instance_console_connection_details.py @@ -0,0 +1,83 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class CreateInstanceConsoleConnectionDetails(object): + + def __init__(self): + + self.swagger_types = { + 'instance_id': 'str', + 'public_key': 'str' + } + + self.attribute_map = { + 'instance_id': 'instanceId', + 'public_key': 'publicKey' + } + + self._instance_id = None + self._public_key = None + + @property + def instance_id(self): + """ + Gets the instance_id of this CreateInstanceConsoleConnectionDetails. + The host instance OCID + + + :return: The instance_id of this CreateInstanceConsoleConnectionDetails. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this CreateInstanceConsoleConnectionDetails. + The host instance OCID + + + :param instance_id: The instance_id of this CreateInstanceConsoleConnectionDetails. + :type: str + """ + self._instance_id = instance_id + + @property + def public_key(self): + """ + Gets the public_key of this CreateInstanceConsoleConnectionDetails. + An ssh public key that will be used to authenticate the console connection. + + + :return: The public_key of this CreateInstanceConsoleConnectionDetails. + :rtype: str + """ + return self._public_key + + @public_key.setter + def public_key(self, public_key): + """ + Sets the public_key of this CreateInstanceConsoleConnectionDetails. + An ssh public key that will be used to authenticate the console connection. + + + :param public_key: The public_key of this CreateInstanceConsoleConnectionDetails. + :type: str + """ + self._public_key = public_key + + 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/oraclebmc/core/models/create_internet_gateway_details.py b/src/oci/core/models/create_internet_gateway_details.py similarity index 100% rename from src/oraclebmc/core/models/create_internet_gateway_details.py rename to src/oci/core/models/create_internet_gateway_details.py diff --git a/src/oraclebmc/core/models/create_ip_sec_connection_details.py b/src/oci/core/models/create_ip_sec_connection_details.py similarity index 100% rename from src/oraclebmc/core/models/create_ip_sec_connection_details.py rename to src/oci/core/models/create_ip_sec_connection_details.py diff --git a/src/oraclebmc/core/models/create_private_ip_details.py b/src/oci/core/models/create_private_ip_details.py similarity index 100% rename from src/oraclebmc/core/models/create_private_ip_details.py rename to src/oci/core/models/create_private_ip_details.py diff --git a/src/oraclebmc/core/models/create_route_table_details.py b/src/oci/core/models/create_route_table_details.py similarity index 100% rename from src/oraclebmc/core/models/create_route_table_details.py rename to src/oci/core/models/create_route_table_details.py diff --git a/src/oraclebmc/core/models/create_security_list_details.py b/src/oci/core/models/create_security_list_details.py similarity index 100% rename from src/oraclebmc/core/models/create_security_list_details.py rename to src/oci/core/models/create_security_list_details.py diff --git a/src/oraclebmc/core/models/create_subnet_details.py b/src/oci/core/models/create_subnet_details.py similarity index 97% rename from src/oraclebmc/core/models/create_subnet_details.py rename to src/oci/core/models/create_subnet_details.py index 95efaed4cc..db10f95bbf 100644 --- a/src/oraclebmc/core/models/create_subnet_details.py +++ b/src/oci/core/models/create_subnet_details.py @@ -182,7 +182,7 @@ def dns_label(self): Gets the dns_label of this CreateSubnetDetails. A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC - within this subnet (e.g., `bminstance-1.subnet123.vcn1.oraclevcn.com`). + within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed. @@ -209,7 +209,7 @@ def dns_label(self, dns_label): Sets the dns_label of this CreateSubnetDetails. A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC - within this subnet (e.g., `bminstance-1.subnet123.vcn1.oraclevcn.com`). + within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed. @@ -240,7 +240,7 @@ def prohibit_public_ip_on_vnic(self): otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in :class:`CreateVnicDetails`). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this - subnet cannot have public IP addresses (i.e., it's a private + subnet cannot have public IP addresses (that is, it's a private subnet). Example: `true` @@ -261,7 +261,7 @@ def prohibit_public_ip_on_vnic(self, prohibit_public_ip_on_vnic): otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in :class:`CreateVnicDetails`). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this - subnet cannot have public IP addresses (i.e., it's a private + subnet cannot have public IP addresses (that is, it's a private subnet). Example: `true` diff --git a/src/oraclebmc/core/models/create_vcn_details.py b/src/oci/core/models/create_vcn_details.py similarity index 96% rename from src/oraclebmc/core/models/create_vcn_details.py rename to src/oci/core/models/create_vcn_details.py index f1d7cb07e1..43faceaffb 100644 --- a/src/oraclebmc/core/models/create_vcn_details.py +++ b/src/oci/core/models/create_vcn_details.py @@ -110,7 +110,7 @@ def dns_label(self): Gets the dns_label of this CreateVcnDetails. A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC - within this subnet (e.g., `bminstance-1.subnet123.vcn1.oraclevcn.com`). + within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Not required to be unique, but it's a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. The value cannot be changed. @@ -138,7 +138,7 @@ def dns_label(self, dns_label): Sets the dns_label of this CreateVcnDetails. A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC - within this subnet (e.g., `bminstance-1.subnet123.vcn1.oraclevcn.com`). + within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Not required to be unique, but it's a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. The value cannot be changed. diff --git a/src/oraclebmc/core/models/create_virtual_circuit_details.py b/src/oci/core/models/create_virtual_circuit_details.py similarity index 98% rename from src/oraclebmc/core/models/create_virtual_circuit_details.py rename to src/oci/core/models/create_virtual_circuit_details.py index 27fe80eb31..a798f21fdb 100644 --- a/src/oraclebmc/core/models/create_virtual_circuit_details.py +++ b/src/oci/core/models/create_virtual_circuit_details.py @@ -51,7 +51,7 @@ def bandwidth_shape_name(self): """ Gets the bandwidth_shape_name of this CreateVirtualCircuitDetails. The provisioned data rate of the connection. To get a list of the - available bandwidth levels (i.e., shapes), see + available bandwidth levels (that is, shapes), see :func:`list_virtual_circuit_bandwidth_shapes`. Example: `10 Gbps` @@ -67,7 +67,7 @@ def bandwidth_shape_name(self, bandwidth_shape_name): """ Sets the bandwidth_shape_name of this CreateVirtualCircuitDetails. The provisioned data rate of the connection. To get a list of the - available bandwidth levels (i.e., shapes), see + available bandwidth levels (that is, shapes), see :func:`list_virtual_circuit_bandwidth_shapes`. Example: `10 Gbps` diff --git a/src/oraclebmc/core/models/create_vnic_details.py b/src/oci/core/models/create_vnic_details.py similarity index 97% rename from src/oraclebmc/core/models/create_vnic_details.py rename to src/oci/core/models/create_vnic_details.py index f8ab039896..1901f65b3e 100644 --- a/src/oraclebmc/core/models/create_vnic_details.py +++ b/src/oci/core/models/create_vnic_details.py @@ -37,7 +37,7 @@ def assign_public_ip(self): Gets the assign_public_ip of this CreateVnicDetails. Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created - in a private subnet (i.e., where `prohibitPublicIpOnVnic` = true in the + in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the :class:`Subnet`), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and @@ -46,7 +46,7 @@ def assign_public_ip(self): **Note:** This public IP address is associated with the primary private IP on the VNIC. Secondary private IPs cannot have public IP addresses associated with them. For more information, see - `Managing IP Addresses`__. + `IP Addresses`__. Example: `false` @@ -64,7 +64,7 @@ def assign_public_ip(self, assign_public_ip): Sets the assign_public_ip of this CreateVnicDetails. Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created - in a private subnet (i.e., where `prohibitPublicIpOnVnic` = true in the + in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the :class:`Subnet`), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and @@ -73,7 +73,7 @@ def assign_public_ip(self, assign_public_ip): **Note:** This public IP address is associated with the primary private IP on the VNIC. Secondary private IPs cannot have public IP addresses associated with them. For more information, see - `Managing IP Addresses`__. + `IP Addresses`__. Example: `false` diff --git a/src/oraclebmc/core/models/create_volume_backup_details.py b/src/oci/core/models/create_volume_backup_details.py similarity index 100% rename from src/oraclebmc/core/models/create_volume_backup_details.py rename to src/oci/core/models/create_volume_backup_details.py diff --git a/src/oraclebmc/core/models/create_volume_details.py b/src/oci/core/models/create_volume_details.py similarity index 96% rename from src/oraclebmc/core/models/create_volume_details.py rename to src/oci/core/models/create_volume_details.py index fb6bc58411..4d4381fd29 100644 --- a/src/oraclebmc/core/models/create_volume_details.py +++ b/src/oci/core/models/create_volume_details.py @@ -113,7 +113,7 @@ def display_name(self, display_name): def size_in_mbs(self): """ Gets the size_in_mbs of this CreateVolumeDetails. - The size of the volume in MBs. + The size of the volume in MBs. The value must be a multiple of 1024. :return: The size_in_mbs of this CreateVolumeDetails. @@ -125,7 +125,7 @@ def size_in_mbs(self): def size_in_mbs(self, size_in_mbs): """ Sets the size_in_mbs of this CreateVolumeDetails. - The size of the volume in MBs. + The size of the volume in MBs. The value must be a multiple of 1024. :param size_in_mbs: The size_in_mbs of this CreateVolumeDetails. diff --git a/src/oraclebmc/core/models/cross_connect.py b/src/oci/core/models/cross_connect.py similarity index 100% rename from src/oraclebmc/core/models/cross_connect.py rename to src/oci/core/models/cross_connect.py diff --git a/src/oraclebmc/core/models/cross_connect_group.py b/src/oci/core/models/cross_connect_group.py similarity index 100% rename from src/oraclebmc/core/models/cross_connect_group.py rename to src/oci/core/models/cross_connect_group.py diff --git a/src/oraclebmc/core/models/cross_connect_location.py b/src/oci/core/models/cross_connect_location.py similarity index 100% rename from src/oraclebmc/core/models/cross_connect_location.py rename to src/oci/core/models/cross_connect_location.py diff --git a/src/oraclebmc/core/models/cross_connect_mapping.py b/src/oci/core/models/cross_connect_mapping.py similarity index 96% rename from src/oraclebmc/core/models/cross_connect_mapping.py rename to src/oci/core/models/cross_connect_mapping.py index f3e82171a4..c417bf8748 100644 --- a/src/oraclebmc/core/models/cross_connect_mapping.py +++ b/src/oci/core/models/cross_connect_mapping.py @@ -65,7 +65,7 @@ def cross_connect_or_cross_connect_group_id(self): Gets the cross_connect_or_cross_connect_group_id of this CrossConnectMapping. The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the - customer if the customer is colocated with Oracle; the provider if the + customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). @@ -80,7 +80,7 @@ def cross_connect_or_cross_connect_group_id(self, cross_connect_or_cross_connect Sets the cross_connect_or_cross_connect_group_id of this CrossConnectMapping. The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the - customer if the customer is colocated with Oracle; the provider if the + customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). @@ -129,7 +129,7 @@ def customer_bgp_peering_ip(self, customer_bgp_peering_ip): def oracle_bgp_peering_ip(self): """ Gets the oracle_bgp_peering_ip of this CrossConnectMapping. - The IP address for Oracle's end of the BPG session. Must use a /30 or /31 + The IP address for Oracle's end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this. @@ -146,7 +146,7 @@ def oracle_bgp_peering_ip(self): def oracle_bgp_peering_ip(self, oracle_bgp_peering_ip): """ Sets the oracle_bgp_peering_ip of this CrossConnectMapping. - The IP address for Oracle's end of the BPG session. Must use a /30 or /31 + The IP address for Oracle's end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this. diff --git a/src/oraclebmc/core/models/cross_connect_port_speed_shape.py b/src/oci/core/models/cross_connect_port_speed_shape.py similarity index 100% rename from src/oraclebmc/core/models/cross_connect_port_speed_shape.py rename to src/oci/core/models/cross_connect_port_speed_shape.py diff --git a/src/oraclebmc/core/models/cross_connect_status.py b/src/oci/core/models/cross_connect_status.py similarity index 100% rename from src/oraclebmc/core/models/cross_connect_status.py rename to src/oci/core/models/cross_connect_status.py diff --git a/src/oraclebmc/core/models/dhcp_dns_option.py b/src/oci/core/models/dhcp_dns_option.py similarity index 100% rename from src/oraclebmc/core/models/dhcp_dns_option.py rename to src/oci/core/models/dhcp_dns_option.py diff --git a/src/oraclebmc/core/models/dhcp_option.py b/src/oci/core/models/dhcp_option.py similarity index 100% rename from src/oraclebmc/core/models/dhcp_option.py rename to src/oci/core/models/dhcp_option.py diff --git a/src/oraclebmc/core/models/dhcp_options.py b/src/oci/core/models/dhcp_options.py similarity index 100% rename from src/oraclebmc/core/models/dhcp_options.py rename to src/oci/core/models/dhcp_options.py diff --git a/src/oraclebmc/core/models/dhcp_search_domain_option.py b/src/oci/core/models/dhcp_search_domain_option.py similarity index 97% rename from src/oraclebmc/core/models/dhcp_search_domain_option.py rename to src/oci/core/models/dhcp_search_domain_option.py index 612013162d..e2bad4c743 100644 --- a/src/oraclebmc/core/models/dhcp_search_domain_option.py +++ b/src/oci/core/models/dhcp_search_domain_option.py @@ -34,7 +34,7 @@ def search_domain_names(self): If you set :class:`DhcpDnsOption` to `VcnLocalPlusInternet`, and you assign a DNS label to the VCN during creation, the search domain name in the VCN's default set of DHCP options is automatically set to the VCN domain - (e.g., `vcn1.oraclevcn.com`). + (for example, `vcn1.oraclevcn.com`). If you don't want to use a search domain name, omit this option from the set of DHCP options. Do not include this option with an empty list @@ -61,7 +61,7 @@ def search_domain_names(self, search_domain_names): If you set :class:`DhcpDnsOption` to `VcnLocalPlusInternet`, and you assign a DNS label to the VCN during creation, the search domain name in the VCN's default set of DHCP options is automatically set to the VCN domain - (e.g., `vcn1.oraclevcn.com`). + (for example, `vcn1.oraclevcn.com`). If you don't want to use a search domain name, omit this option from the set of DHCP options. Do not include this option with an empty list diff --git a/src/oraclebmc/core/models/drg.py b/src/oci/core/models/drg.py similarity index 100% rename from src/oraclebmc/core/models/drg.py rename to src/oci/core/models/drg.py diff --git a/src/oraclebmc/core/models/drg_attachment.py b/src/oci/core/models/drg_attachment.py similarity index 100% rename from src/oraclebmc/core/models/drg_attachment.py rename to src/oci/core/models/drg_attachment.py diff --git a/src/oraclebmc/core/models/egress_security_rule.py b/src/oci/core/models/egress_security_rule.py similarity index 100% rename from src/oraclebmc/core/models/egress_security_rule.py rename to src/oci/core/models/egress_security_rule.py diff --git a/src/oraclebmc/core/models/export_image_details.py b/src/oci/core/models/export_image_details.py similarity index 100% rename from src/oraclebmc/core/models/export_image_details.py rename to src/oci/core/models/export_image_details.py diff --git a/src/oraclebmc/core/models/export_image_via_object_storage_tuple_details.py b/src/oci/core/models/export_image_via_object_storage_tuple_details.py similarity index 100% rename from src/oraclebmc/core/models/export_image_via_object_storage_tuple_details.py rename to src/oci/core/models/export_image_via_object_storage_tuple_details.py diff --git a/src/oraclebmc/core/models/export_image_via_object_storage_uri_details.py b/src/oci/core/models/export_image_via_object_storage_uri_details.py similarity index 100% rename from src/oraclebmc/core/models/export_image_via_object_storage_uri_details.py rename to src/oci/core/models/export_image_via_object_storage_uri_details.py diff --git a/src/oraclebmc/core/models/fast_connect_provider_service.py b/src/oci/core/models/fast_connect_provider_service.py similarity index 100% rename from src/oraclebmc/core/models/fast_connect_provider_service.py rename to src/oci/core/models/fast_connect_provider_service.py diff --git a/src/oraclebmc/core/models/i_scsi_volume_attachment.py b/src/oci/core/models/i_scsi_volume_attachment.py similarity index 100% rename from src/oraclebmc/core/models/i_scsi_volume_attachment.py rename to src/oci/core/models/i_scsi_volume_attachment.py diff --git a/src/oraclebmc/core/models/icmp_options.py b/src/oci/core/models/icmp_options.py similarity index 100% rename from src/oraclebmc/core/models/icmp_options.py rename to src/oci/core/models/icmp_options.py diff --git a/src/oraclebmc/core/models/image.py b/src/oci/core/models/image.py similarity index 100% rename from src/oraclebmc/core/models/image.py rename to src/oci/core/models/image.py diff --git a/src/oraclebmc/core/models/image_source_details.py b/src/oci/core/models/image_source_details.py similarity index 100% rename from src/oraclebmc/core/models/image_source_details.py rename to src/oci/core/models/image_source_details.py diff --git a/src/oraclebmc/core/models/image_source_via_object_storage_tuple_details.py b/src/oci/core/models/image_source_via_object_storage_tuple_details.py similarity index 100% rename from src/oraclebmc/core/models/image_source_via_object_storage_tuple_details.py rename to src/oci/core/models/image_source_via_object_storage_tuple_details.py diff --git a/src/oraclebmc/core/models/image_source_via_object_storage_uri_details.py b/src/oci/core/models/image_source_via_object_storage_uri_details.py similarity index 100% rename from src/oraclebmc/core/models/image_source_via_object_storage_uri_details.py rename to src/oci/core/models/image_source_via_object_storage_uri_details.py diff --git a/src/oraclebmc/core/models/ingress_security_rule.py b/src/oci/core/models/ingress_security_rule.py similarity index 100% rename from src/oraclebmc/core/models/ingress_security_rule.py rename to src/oci/core/models/ingress_security_rule.py diff --git a/src/oraclebmc/core/models/instance.py b/src/oci/core/models/instance.py similarity index 100% rename from src/oraclebmc/core/models/instance.py rename to src/oci/core/models/instance.py diff --git a/src/oci/core/models/instance_console_connection.py b/src/oci/core/models/instance_console_connection.py new file mode 100644 index 0000000000..05366d8c8f --- /dev/null +++ b/src/oci/core/models/instance_console_connection.py @@ -0,0 +1,197 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class InstanceConsoleConnection(object): + + def __init__(self): + + self.swagger_types = { + 'compartment_id': 'str', + 'connection_string': 'str', + 'fingerprint': 'str', + 'id': 'str', + 'instance_id': 'str', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'connection_string': 'connectionString', + 'fingerprint': 'fingerprint', + 'id': 'id', + 'instance_id': 'instanceId', + 'lifecycle_state': 'lifecycleState' + } + + self._compartment_id = None + self._connection_string = None + self._fingerprint = None + self._id = None + self._instance_id = None + self._lifecycle_state = None + + @property + def compartment_id(self): + """ + Gets the compartment_id of this InstanceConsoleConnection. + The OCID of the compartment to contain the ConsoleConnection + + + :return: The compartment_id of this InstanceConsoleConnection. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this InstanceConsoleConnection. + The OCID of the compartment to contain the ConsoleConnection + + + :param compartment_id: The compartment_id of this InstanceConsoleConnection. + :type: str + """ + self._compartment_id = compartment_id + + @property + def connection_string(self): + """ + Gets the connection_string of this InstanceConsoleConnection. + The ssh connection string to the instance console + + + :return: The connection_string of this InstanceConsoleConnection. + :rtype: str + """ + return self._connection_string + + @connection_string.setter + def connection_string(self, connection_string): + """ + Sets the connection_string of this InstanceConsoleConnection. + The ssh connection string to the instance console + + + :param connection_string: The connection_string of this InstanceConsoleConnection. + :type: str + """ + self._connection_string = connection_string + + @property + def fingerprint(self): + """ + Gets the fingerprint of this InstanceConsoleConnection. + The fingerprint of the ssh publicKey. + + + :return: The fingerprint of this InstanceConsoleConnection. + :rtype: str + """ + return self._fingerprint + + @fingerprint.setter + def fingerprint(self, fingerprint): + """ + Sets the fingerprint of this InstanceConsoleConnection. + The fingerprint of the ssh publicKey. + + + :param fingerprint: The fingerprint of this InstanceConsoleConnection. + :type: str + """ + self._fingerprint = fingerprint + + @property + def id(self): + """ + Gets the id of this InstanceConsoleConnection. + The OCID of the instance console connection + + + :return: The id of this InstanceConsoleConnection. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this InstanceConsoleConnection. + The OCID of the instance console connection + + + :param id: The id of this InstanceConsoleConnection. + :type: str + """ + self._id = id + + @property + def instance_id(self): + """ + Gets the instance_id of this InstanceConsoleConnection. + The host instance OCID + + + :return: The instance_id of this InstanceConsoleConnection. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this InstanceConsoleConnection. + The host instance OCID + + + :param instance_id: The instance_id of this InstanceConsoleConnection. + :type: str + """ + self._instance_id = instance_id + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this InstanceConsoleConnection. + The current state of the instance console connection. + + Allowed values for this property are: "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this InstanceConsoleConnection. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this InstanceConsoleConnection. + The current state of the instance console connection. + + + :param lifecycle_state: The lifecycle_state of this InstanceConsoleConnection. + :type: str + """ + allowed_values = ["ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + 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/oraclebmc/core/models/instance_credentials.py b/src/oci/core/models/instance_credentials.py similarity index 100% rename from src/oraclebmc/core/models/instance_credentials.py rename to src/oci/core/models/instance_credentials.py diff --git a/src/oraclebmc/core/models/internet_gateway.py b/src/oci/core/models/internet_gateway.py similarity index 100% rename from src/oraclebmc/core/models/internet_gateway.py rename to src/oci/core/models/internet_gateway.py diff --git a/src/oraclebmc/core/models/ip_sec_connection.py b/src/oci/core/models/ip_sec_connection.py similarity index 100% rename from src/oraclebmc/core/models/ip_sec_connection.py rename to src/oci/core/models/ip_sec_connection.py diff --git a/src/oraclebmc/core/models/ip_sec_connection_device_config.py b/src/oci/core/models/ip_sec_connection_device_config.py similarity index 100% rename from src/oraclebmc/core/models/ip_sec_connection_device_config.py rename to src/oci/core/models/ip_sec_connection_device_config.py diff --git a/src/oraclebmc/core/models/ip_sec_connection_device_status.py b/src/oci/core/models/ip_sec_connection_device_status.py similarity index 100% rename from src/oraclebmc/core/models/ip_sec_connection_device_status.py rename to src/oci/core/models/ip_sec_connection_device_status.py diff --git a/src/oraclebmc/core/models/launch_instance_details.py b/src/oci/core/models/launch_instance_details.py similarity index 100% rename from src/oraclebmc/core/models/launch_instance_details.py rename to src/oci/core/models/launch_instance_details.py diff --git a/src/oraclebmc/core/models/letter_of_authority.py b/src/oci/core/models/letter_of_authority.py similarity index 100% rename from src/oraclebmc/core/models/letter_of_authority.py rename to src/oci/core/models/letter_of_authority.py diff --git a/src/oraclebmc/core/models/port_range.py b/src/oci/core/models/port_range.py similarity index 100% rename from src/oraclebmc/core/models/port_range.py rename to src/oci/core/models/port_range.py diff --git a/src/oraclebmc/core/models/private_ip.py b/src/oci/core/models/private_ip.py similarity index 100% rename from src/oraclebmc/core/models/private_ip.py rename to src/oci/core/models/private_ip.py diff --git a/src/oraclebmc/core/models/route_rule.py b/src/oci/core/models/route_rule.py similarity index 100% rename from src/oraclebmc/core/models/route_rule.py rename to src/oci/core/models/route_rule.py diff --git a/src/oraclebmc/core/models/route_table.py b/src/oci/core/models/route_table.py similarity index 100% rename from src/oraclebmc/core/models/route_table.py rename to src/oci/core/models/route_table.py diff --git a/src/oraclebmc/core/models/security_list.py b/src/oci/core/models/security_list.py similarity index 100% rename from src/oraclebmc/core/models/security_list.py rename to src/oci/core/models/security_list.py diff --git a/src/oraclebmc/core/models/shape.py b/src/oci/core/models/shape.py similarity index 100% rename from src/oraclebmc/core/models/shape.py rename to src/oci/core/models/shape.py diff --git a/src/oraclebmc/core/models/subnet.py b/src/oci/core/models/subnet.py similarity index 98% rename from src/oraclebmc/core/models/subnet.py rename to src/oci/core/models/subnet.py index d621fcec37..cc9c7a033e 100644 --- a/src/oraclebmc/core/models/subnet.py +++ b/src/oci/core/models/subnet.py @@ -200,7 +200,7 @@ def dns_label(self): Gets the dns_label of this Subnet. A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC - within this subnet (e.g., `bminstance-1.subnet123.vcn1.oraclevcn.com`). + within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed. @@ -226,7 +226,7 @@ def dns_label(self, dns_label): Sets the dns_label of this Subnet. A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC - within this subnet (e.g., `bminstance-1.subnet123.vcn1.oraclevcn.com`). + within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed. @@ -311,7 +311,7 @@ def prohibit_public_ip_on_vnic(self): `assignPublicIp` flag in :class:`CreateVnicDetails`). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this - subnet cannot have public IP addresses (i.e., it's a private + subnet cannot have public IP addresses (that is, it's a private subnet). Example: `true` @@ -333,7 +333,7 @@ def prohibit_public_ip_on_vnic(self, prohibit_public_ip_on_vnic): `assignPublicIp` flag in :class:`CreateVnicDetails`). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this - subnet cannot have public IP addresses (i.e., it's a private + subnet cannot have public IP addresses (that is, it's a private subnet). Example: `true` diff --git a/src/oraclebmc/core/models/tcp_options.py b/src/oci/core/models/tcp_options.py similarity index 100% rename from src/oraclebmc/core/models/tcp_options.py rename to src/oci/core/models/tcp_options.py diff --git a/src/oraclebmc/core/models/tunnel_config.py b/src/oci/core/models/tunnel_config.py similarity index 100% rename from src/oraclebmc/core/models/tunnel_config.py rename to src/oci/core/models/tunnel_config.py diff --git a/src/oraclebmc/core/models/tunnel_status.py b/src/oci/core/models/tunnel_status.py similarity index 100% rename from src/oraclebmc/core/models/tunnel_status.py rename to src/oci/core/models/tunnel_status.py diff --git a/src/oraclebmc/core/models/udp_options.py b/src/oci/core/models/udp_options.py similarity index 100% rename from src/oraclebmc/core/models/udp_options.py rename to src/oci/core/models/udp_options.py diff --git a/src/oraclebmc/core/models/update_cpe_details.py b/src/oci/core/models/update_cpe_details.py similarity index 100% rename from src/oraclebmc/core/models/update_cpe_details.py rename to src/oci/core/models/update_cpe_details.py diff --git a/src/oraclebmc/core/models/update_cross_connect_details.py b/src/oci/core/models/update_cross_connect_details.py similarity index 100% rename from src/oraclebmc/core/models/update_cross_connect_details.py rename to src/oci/core/models/update_cross_connect_details.py diff --git a/src/oraclebmc/core/models/update_cross_connect_group_details.py b/src/oci/core/models/update_cross_connect_group_details.py similarity index 100% rename from src/oraclebmc/core/models/update_cross_connect_group_details.py rename to src/oci/core/models/update_cross_connect_group_details.py diff --git a/src/oraclebmc/core/models/update_dhcp_details.py b/src/oci/core/models/update_dhcp_details.py similarity index 100% rename from src/oraclebmc/core/models/update_dhcp_details.py rename to src/oci/core/models/update_dhcp_details.py diff --git a/src/oraclebmc/core/models/update_drg_attachment_details.py b/src/oci/core/models/update_drg_attachment_details.py similarity index 100% rename from src/oraclebmc/core/models/update_drg_attachment_details.py rename to src/oci/core/models/update_drg_attachment_details.py diff --git a/src/oraclebmc/core/models/update_drg_details.py b/src/oci/core/models/update_drg_details.py similarity index 100% rename from src/oraclebmc/core/models/update_drg_details.py rename to src/oci/core/models/update_drg_details.py diff --git a/src/oraclebmc/core/models/update_image_details.py b/src/oci/core/models/update_image_details.py similarity index 100% rename from src/oraclebmc/core/models/update_image_details.py rename to src/oci/core/models/update_image_details.py diff --git a/src/oraclebmc/core/models/update_instance_details.py b/src/oci/core/models/update_instance_details.py similarity index 100% rename from src/oraclebmc/core/models/update_instance_details.py rename to src/oci/core/models/update_instance_details.py diff --git a/src/oraclebmc/core/models/update_internet_gateway_details.py b/src/oci/core/models/update_internet_gateway_details.py similarity index 100% rename from src/oraclebmc/core/models/update_internet_gateway_details.py rename to src/oci/core/models/update_internet_gateway_details.py diff --git a/src/oraclebmc/core/models/update_ip_sec_connection_details.py b/src/oci/core/models/update_ip_sec_connection_details.py similarity index 100% rename from src/oraclebmc/core/models/update_ip_sec_connection_details.py rename to src/oci/core/models/update_ip_sec_connection_details.py diff --git a/src/oraclebmc/core/models/update_private_ip_details.py b/src/oci/core/models/update_private_ip_details.py similarity index 100% rename from src/oraclebmc/core/models/update_private_ip_details.py rename to src/oci/core/models/update_private_ip_details.py diff --git a/src/oraclebmc/core/models/update_route_table_details.py b/src/oci/core/models/update_route_table_details.py similarity index 100% rename from src/oraclebmc/core/models/update_route_table_details.py rename to src/oci/core/models/update_route_table_details.py diff --git a/src/oraclebmc/core/models/update_security_list_details.py b/src/oci/core/models/update_security_list_details.py similarity index 100% rename from src/oraclebmc/core/models/update_security_list_details.py rename to src/oci/core/models/update_security_list_details.py diff --git a/src/oraclebmc/core/models/update_subnet_details.py b/src/oci/core/models/update_subnet_details.py similarity index 100% rename from src/oraclebmc/core/models/update_subnet_details.py rename to src/oci/core/models/update_subnet_details.py diff --git a/src/oraclebmc/core/models/update_vcn_details.py b/src/oci/core/models/update_vcn_details.py similarity index 100% rename from src/oraclebmc/core/models/update_vcn_details.py rename to src/oci/core/models/update_vcn_details.py diff --git a/src/oraclebmc/core/models/update_virtual_circuit_details.py b/src/oci/core/models/update_virtual_circuit_details.py similarity index 98% rename from src/oraclebmc/core/models/update_virtual_circuit_details.py rename to src/oci/core/models/update_virtual_circuit_details.py index 35ef8b8a98..63a5014417 100644 --- a/src/oraclebmc/core/models/update_virtual_circuit_details.py +++ b/src/oci/core/models/update_virtual_circuit_details.py @@ -42,7 +42,7 @@ def bandwidth_shape_name(self): """ Gets the bandwidth_shape_name of this UpdateVirtualCircuitDetails. The provisioned data rate of the connection. To get a list of the - available bandwidth levels (i.e., shapes), see + available bandwidth levels (that is, shapes), see :func:`list_virtual_circuit_bandwidth_shapes`. To be updated only by the customer who owns the virtual circuit. @@ -58,7 +58,7 @@ def bandwidth_shape_name(self, bandwidth_shape_name): """ Sets the bandwidth_shape_name of this UpdateVirtualCircuitDetails. The provisioned data rate of the connection. To get a list of the - available bandwidth levels (i.e., shapes), see + available bandwidth levels (that is, shapes), see :func:`list_virtual_circuit_bandwidth_shapes`. To be updated only by the customer who owns the virtual circuit. diff --git a/src/oraclebmc/core/models/update_vnic_details.py b/src/oci/core/models/update_vnic_details.py similarity index 100% rename from src/oraclebmc/core/models/update_vnic_details.py rename to src/oci/core/models/update_vnic_details.py diff --git a/src/oraclebmc/core/models/update_volume_backup_details.py b/src/oci/core/models/update_volume_backup_details.py similarity index 100% rename from src/oraclebmc/core/models/update_volume_backup_details.py rename to src/oci/core/models/update_volume_backup_details.py diff --git a/src/oraclebmc/core/models/update_volume_details.py b/src/oci/core/models/update_volume_details.py similarity index 100% rename from src/oraclebmc/core/models/update_volume_details.py rename to src/oci/core/models/update_volume_details.py diff --git a/src/oraclebmc/core/models/vcn.py b/src/oci/core/models/vcn.py similarity index 98% rename from src/oraclebmc/core/models/vcn.py rename to src/oci/core/models/vcn.py index 378e318b27..a48ab6fc7e 100644 --- a/src/oraclebmc/core/models/vcn.py +++ b/src/oci/core/models/vcn.py @@ -205,7 +205,7 @@ def dns_label(self): Gets the dns_label of this Vcn. A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC - within this subnet (e.g., `bminstance-1.subnet123.vcn1.oraclevcn.com`). + within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter. The value cannot be changed. @@ -231,7 +231,7 @@ def dns_label(self, dns_label): Sets the dns_label of this Vcn. A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC - within this subnet (e.g., `bminstance-1.subnet123.vcn1.oraclevcn.com`). + within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter. The value cannot be changed. diff --git a/src/oraclebmc/core/models/virtual_circuit.py b/src/oci/core/models/virtual_circuit.py similarity index 100% rename from src/oraclebmc/core/models/virtual_circuit.py rename to src/oci/core/models/virtual_circuit.py diff --git a/src/oraclebmc/core/models/virtual_circuit_bandwidth_shape.py b/src/oci/core/models/virtual_circuit_bandwidth_shape.py similarity index 100% rename from src/oraclebmc/core/models/virtual_circuit_bandwidth_shape.py rename to src/oci/core/models/virtual_circuit_bandwidth_shape.py diff --git a/src/oraclebmc/core/models/vnic.py b/src/oci/core/models/vnic.py similarity index 98% rename from src/oraclebmc/core/models/vnic.py rename to src/oci/core/models/vnic.py index 4c1b4925b9..10897c9d47 100644 --- a/src/oraclebmc/core/models/vnic.py +++ b/src/oci/core/models/vnic.py @@ -136,7 +136,7 @@ def hostname_label(self): Gets the hostname_label of this Vnic. The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) - (e.g., `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). + (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with `RFC 952`__ and `RFC 1123`__. @@ -162,7 +162,7 @@ def hostname_label(self, hostname_label): Sets the hostname_label of this Vnic. The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) - (e.g., `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). + (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with `RFC 952`__ and `RFC 1123`__. diff --git a/src/oraclebmc/core/models/vnic_attachment.py b/src/oci/core/models/vnic_attachment.py similarity index 100% rename from src/oraclebmc/core/models/vnic_attachment.py rename to src/oci/core/models/vnic_attachment.py diff --git a/src/oraclebmc/core/models/volume.py b/src/oci/core/models/volume.py similarity index 97% rename from src/oraclebmc/core/models/volume.py rename to src/oci/core/models/volume.py index 71101b7739..9d76a48453 100644 --- a/src/oraclebmc/core/models/volume.py +++ b/src/oci/core/models/volume.py @@ -173,7 +173,7 @@ def lifecycle_state(self, lifecycle_state): def size_in_mbs(self): """ Gets the size_in_mbs of this Volume. - The size of the volume in MBs. + The size of the volume in MBs. The value must be a multiple of 1024. :return: The size_in_mbs of this Volume. @@ -185,7 +185,7 @@ def size_in_mbs(self): def size_in_mbs(self, size_in_mbs): """ Sets the size_in_mbs of this Volume. - The size of the volume in MBs. + The size of the volume in MBs. The value must be a multiple of 1024. :param size_in_mbs: The size_in_mbs of this Volume. diff --git a/src/oraclebmc/core/models/volume_attachment.py b/src/oci/core/models/volume_attachment.py similarity index 100% rename from src/oraclebmc/core/models/volume_attachment.py rename to src/oci/core/models/volume_attachment.py diff --git a/src/oraclebmc/core/models/volume_backup.py b/src/oci/core/models/volume_backup.py similarity index 98% rename from src/oraclebmc/core/models/volume_backup.py rename to src/oci/core/models/volume_backup.py index 64f22e4e2d..2e44b894fd 100644 --- a/src/oraclebmc/core/models/volume_backup.py +++ b/src/oci/core/models/volume_backup.py @@ -151,7 +151,7 @@ def lifecycle_state(self, lifecycle_state): def size_in_mbs(self): """ Gets the size_in_mbs of this VolumeBackup. - The size of the volume, in MBs. + The size of the volume, in MBs. The value must be a multiple of 1024. :return: The size_in_mbs of this VolumeBackup. @@ -163,7 +163,7 @@ def size_in_mbs(self): def size_in_mbs(self, size_in_mbs): """ Sets the size_in_mbs of this VolumeBackup. - The size of the volume, in MBs. + The size of the volume, in MBs. The value must be a multiple of 1024. :param size_in_mbs: The size_in_mbs of this VolumeBackup. diff --git a/src/oraclebmc/core/virtual_network_client.py b/src/oci/core/virtual_network_client.py similarity index 90% rename from src/oraclebmc/core/virtual_network_client.py rename to src/oci/core/virtual_network_client.py index 4117425cb3..6a67679ea0 100644 --- a/src/oraclebmc/core/virtual_network_client.py +++ b/src/oci/core/virtual_network_client.py @@ -30,7 +30,7 @@ def create_cpe(self, create_cpe_details, **kwargs): """ CreateCpe Creates a new virtual Customer-Premises Equipment (CPE) object in the specified compartment. For - more information, see `Managing IPSec VPNs`__. + more information, see `IPSec VPNs`__. For the purposes of access control, you must provide the OCID of the compartment where you want the CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec @@ -39,8 +39,8 @@ def create_cpe(self, create_cpe_details, **kwargs): compartments and access control, see `Overview of the IAM Service`__. For information about OCIDs, see `Resource Identifiers`__. - You must provide the public IP address of your on-premise router. See - `Configuring Your On-Premise Router`__. + You must provide the public IP address of your on-premises router. See + `Configuring Your On-Premises Router for an IPSec VPN`__. You may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. @@ -57,12 +57,12 @@ def create_cpe(self, create_cpe_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Cpe` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Cpe` + :rtype: :class:`~oci.response.Response` """ resource_path = "/cpes" method = "POST" @@ -124,12 +124,12 @@ def create_cross_connect(self, create_cross_connect_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.CrossConnect` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnect` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnects" method = "POST" @@ -187,12 +187,12 @@ def create_cross_connect_group(self, create_cross_connect_group_details, **kwarg :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.CrossConnectGroup` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnectGroup` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnectGroups" method = "POST" @@ -246,12 +246,12 @@ def create_dhcp_options(self, create_dhcp_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.DhcpOptions` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DhcpOptions` + :rtype: :class:`~oci.response.Response` """ resource_path = "/dhcps" method = "POST" @@ -283,7 +283,7 @@ def create_drg(self, create_drg_details, **kwargs): """ CreateDrg Creates a new Dynamic Routing Gateway (DRG) in the specified compartment. For more information, - see `Managing Dynamic Routing Gateways (DRGs)`__. + see `Dynamic Routing Gateways (DRGs)`__. For the purposes of access control, you must provide the OCID of the compartment where you want the DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN, @@ -306,12 +306,12 @@ def create_drg(self, create_drg_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Drg` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Drg` + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgs" method = "POST" @@ -345,7 +345,7 @@ def create_drg_attachment(self, create_drg_attachment_details, **kwargs): Attaches the specified DRG to the specified VCN. A VCN can be attached to only one DRG at a time, and vice versa. The response includes a `DrgAttachment` object with its own OCID. For more information about DRGs, see - `Managing Dynamic Routing Gateways (DRGs)`__. + `Dynamic Routing Gateways (DRGs)`__. You may optionally specify a *display name* for the attachment, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. @@ -364,12 +364,12 @@ def create_drg_attachment(self, create_drg_attachment_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.DrgAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DrgAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgAttachments" method = "POST" @@ -401,7 +401,7 @@ def create_internet_gateway(self, create_internet_gateway_details, **kwargs): """ CreateInternetGateway Creates a new Internet Gateway for the specified VCN. For more information, see - `Managing Internet Gateways`__. + `Connectivity to the Internet`__. For the purposes of access control, you must provide the OCID of the compartment where you want the Internet Gateway to reside. Notice that the Internet Gateway doesn't have to be in the same compartment as the VCN or @@ -414,7 +414,7 @@ def create_internet_gateway(self, create_internet_gateway_details, **kwargs): does not have to be unique, and you can change it. Avoid entering confidential information. For traffic to flow between a subnet and an Internet Gateway, you must create a route rule accordingly in - the subnet's route table (e.g., 0.0.0.0/0 > Internet Gateway). See + the subnet's route table (for example, 0.0.0.0/0 > Internet Gateway). See :func:`update_route_table`. You must specify whether the Internet Gateway is enabled when you create it. If it's disabled, that means no @@ -433,12 +433,12 @@ def create_internet_gateway(self, create_internet_gateway_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.InternetGateway` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InternetGateway` + :rtype: :class:`~oci.response.Response` """ resource_path = "/internetGateways" method = "POST" @@ -470,7 +470,7 @@ def create_ip_sec_connection(self, create_ip_sec_connection_details, **kwargs): """ CreateIPSecConnection Creates a new IPSec connection between the specified DRG and CPE. For more information, see - `Managing IPSec Connections`__. + `IPSec VPNs`__. In the request, you must include at least one static route to the CPE object (you're allowed a maximum of 10). For example: 10.0.8.0/16. @@ -486,12 +486,12 @@ def create_ip_sec_connection(self, create_ip_sec_connection_details, **kwargs): You may optionally specify a *display name* for the IPSec connection, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. - After creating the IPSec connection, you need to configure your on-premise router + After creating the IPSec connection, you need to configure your on-premises router with tunnel-specific information returned by :func:`get_ip_sec_connection_device_config`. For each tunnel, that operation gives you the IP address of Oracle's VPN headend and the shared secret - (i.e., the pre-shared key). For more information, see - `Configuring Your On-Premise Router`__. + (that is, the pre-shared key). For more information, see + `Configuring Your On-Premises Router for an IPSec VPN`__. To get the status of the tunnels (whether they're up or down), use :func:`get_ip_sec_connection_device_status`. @@ -508,12 +508,12 @@ def create_ip_sec_connection(self, create_ip_sec_connection_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.IPSecConnection` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnection` + :rtype: :class:`~oci.response.Response` """ resource_path = "/ipsecConnections" method = "POST" @@ -546,7 +546,7 @@ def create_private_ip(self, create_private_ip_details, **kwargs): CreatePrivateIp Creates a secondary private IP for the specified VNIC. For more information about secondary private IPs, see - `Managing IP Addresses`__. + `IP Addresses`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm @@ -557,12 +557,12 @@ def create_private_ip(self, create_private_ip_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.PrivateIp` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PrivateIp` + :rtype: :class:`~oci.response.Response` """ resource_path = "/privateIps" method = "POST" @@ -596,7 +596,7 @@ def create_route_table(self, create_route_table_details, **kwargs): Creates a new route table for the specified VCN. In the request you must also include at least one route rule for the new route table. For information on the number of rules you can have in a route table, see `Service Limits`__. For general information about route - tables in your VCN, see `Managing Route Tables`__. + tables in your VCN, see `Route Tables`__. For the purposes of access control, you must provide the OCID of the compartment where you want the route table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets, @@ -620,12 +620,12 @@ def create_route_table(self, create_route_table_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.RouteTable` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.RouteTable` + :rtype: :class:`~oci.response.Response` """ resource_path = "/routeTables" method = "POST" @@ -683,12 +683,12 @@ def create_security_list(self, create_security_list_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.SecurityList` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.SecurityList` + :rtype: :class:`~oci.response.Response` """ resource_path = "/securityLists" method = "POST" @@ -721,7 +721,7 @@ def create_subnet(self, create_subnet_details, **kwargs): CreateSubnet Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation, so it's important to think about the size of subnets you need before creating them. - For more information, see `Managing Subnets`__. + For more information, see `VCNs and Subnets`__. For information on the number of subnets you can have in a VCN, see `Service Limits`__. @@ -734,7 +734,7 @@ def create_subnet(self, create_subnet_details, **kwargs): You may optionally associate a route table with the subnet. If you don't, the subnet will use the VCN's default route table. For more information about route tables, see - `Managing Route Tables`__. + `Route Tables`__. You may optionally associate a security list with the subnet. If you don't, the subnet will use the VCN's default security list. For more information about security lists, see @@ -742,7 +742,7 @@ def create_subnet(self, create_subnet_details, **kwargs): You may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the VCN's default set. For more information about DHCP options, see - `Managing DHCP Options`__. + `DHCP Options`__. You may optionally specify a *display name* for the subnet, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. @@ -751,7 +751,7 @@ def create_subnet(self, create_subnet_details, **kwargs): VCN Resolver to resolve hostnames for instances in the subnet. For more information, see `DNS in Your Virtual Cloud Network`__. - __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingsubnets.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVCNs.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -767,12 +767,12 @@ def create_subnet(self, create_subnet_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Subnet` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Subnet` + :rtype: :class:`~oci.response.Response` """ resource_path = "/subnets" method = "POST" @@ -804,12 +804,12 @@ def create_vcn(self, create_vcn_details, **kwargs): """ CreateVcn Creates a new Virtual Cloud Network (VCN). For more information, see - `Managing Virtual Cloud Networks (VCNs)`__. + `VCNs and Subnets`__. For the VCN you must specify a single, contiguous IPv4 CIDR block. Oracle recommends using one of the private IP address ranges specified in `RFC 1918`__ (10.0.0.0/8, 172.16/12, and 192.168/16). Example: 172.16.0.0/16. The CIDR block can range from /16 to /30, and it - must not overlap with your on-premise network. You can't change the size of the VCN after creation. + must not overlap with your on-premises network. You can't change the size of the VCN after creation. For the purposes of access control, you must provide the OCID of the compartment where you want the VCN to reside. Consult an Oracle Bare Metal Cloud Services administrator in your organization if you're not sure which @@ -827,7 +827,7 @@ def create_vcn(self, create_vcn_details, **kwargs): The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The OCID for each is returned in the response. You can't delete these default objects, but you can change their - contents (i.e., route rules, etc.) + contents (that is, change the route rules, security list rules, and so on). The VCN and subnets you create are not accessible until you attach an Internet Gateway or set up an IPSec VPN or FastConnect. For more information, see @@ -847,12 +847,12 @@ def create_vcn(self, create_vcn_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Vcn` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vcn` + :rtype: :class:`~oci.response.Response` """ resource_path = "/vcns" method = "POST" @@ -903,7 +903,7 @@ def create_virtual_circuit(self, create_virtual_circuit_details, **kwargs): the traffic to flow through. Make sure you attach the DRG to your VCN and confirm the VCN's routing sends traffic to the DRG. Otherwise traffic will not flow. For more information, see - `Managing Route Tables`__. + `Route Tables`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm @@ -917,12 +917,12 @@ def create_virtual_circuit(self, create_virtual_circuit_details, **kwargs): :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 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VirtualCircuit` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VirtualCircuit` + :rtype: :class:`~oci.response.Response` """ resource_path = "/virtualCircuits" method = "POST" @@ -954,7 +954,7 @@ def delete_cpe(self, cpe_id, **kwargs): """ DeleteCpe Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous - operation; the CPE's `lifecycleState` will change to TERMINATING temporarily until the CPE is completely + operation. The CPE's `lifecycleState` will change to TERMINATING temporarily until the CPE is completely removed. @@ -966,8 +966,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/cpes/{cpeId}" method = "DELETE" @@ -1014,8 +1014,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnects/{crossConnectId}" method = "DELETE" @@ -1063,8 +1063,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnectGroups/{crossConnectGroupId}" method = "DELETE" @@ -1102,7 +1102,7 @@ def delete_dhcp_options(self, dhcp_id, **kwargs): Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a VCN's default set of DHCP options. - This is an asynchronous operation; the state of the set of options will switch to TERMINATING temporarily + This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily until the set is completely removed. @@ -1114,8 +1114,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/dhcps/{dhcpId}" method = "DELETE" @@ -1152,7 +1152,7 @@ def delete_drg(self, drg_id, **kwargs): DeleteDrg Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise network. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous - operation; the DRG's `lifecycleState` will change to TERMINATING temporarily until the DRG is completely + operation. The DRG's `lifecycleState` will change to TERMINATING temporarily until the DRG is completely removed. @@ -1164,8 +1164,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgs/{drgId}" method = "DELETE" @@ -1201,7 +1201,7 @@ def delete_drg_attachment(self, drg_attachment_id, **kwargs): """ DeleteDrgAttachment Detaches a DRG from a VCN by deleting the corresponding `DrgAttachment`. This is an asynchronous - operation; the attachment's `lifecycleState` will change to DETACHING temporarily until the attachment + operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed. @@ -1213,8 +1213,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgAttachments/{drgAttachmentId}" method = "DELETE" @@ -1252,7 +1252,7 @@ def delete_internet_gateway(self, ig_id, **kwargs): Deletes the specified Internet Gateway. The Internet Gateway does not have to be disabled, but there must not be a route table that lists it as a target. - This is an asynchronous operation; the gateway's `lifecycleState` will change to TERMINATING temporarily + This is an asynchronous operation. The gateway's `lifecycleState` will change to TERMINATING temporarily until the gateway is completely removed. @@ -1264,8 +1264,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/internetGateways/{igId}" method = "DELETE" @@ -1301,12 +1301,12 @@ def delete_ip_sec_connection(self, ipsc_id, **kwargs): """ DeleteIPSecConnection Deletes the specified IPSec connection. If your goal is to disable the IPSec VPN between your VCN and - on-premise network, it's easiest to simply detach the DRG but keep all the IPSec VPN components intact. + on-premises network, it's easiest to simply detach the DRG but keep all the IPSec VPN components intact. If you were to delete all the components and then later need to create an IPSec VPN again, you would - need to configure your on-premise router again with the new information returned from + need to configure your on-premises router again with the new information returned from :func:`create_ip_sec_connection`. - This is an asynchronous operation; the connection's `lifecycleState` will change to TERMINATING temporarily + This is an asynchronous operation. The connection's `lifecycleState` will change to TERMINATING temporarily until the connection is completely removed. @@ -1318,8 +1318,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/ipsecConnections/{ipscId}" method = "DELETE" @@ -1370,8 +1370,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/privateIps/{privateIpId}" method = "DELETE" @@ -1409,7 +1409,7 @@ def delete_route_table(self, rt_id, **kwargs): Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a VCN's default route table. - This is an asynchronous operation; the route table's `lifecycleState` will change to TERMINATING temporarily + This is an asynchronous operation. The route table's `lifecycleState` will change to TERMINATING temporarily until the route table is completely removed. @@ -1421,8 +1421,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/routeTables/{rtId}" method = "DELETE" @@ -1460,7 +1460,7 @@ def delete_security_list(self, security_list_id, **kwargs): Deletes the specified security list, but only if it's not associated with a subnet. You can't delete a VCN's default security list. - This is an asynchronous operation; the security list's `lifecycleState` will change to TERMINATING temporarily + This is an asynchronous operation. The security list's `lifecycleState` will change to TERMINATING temporarily until the security list is completely removed. @@ -1472,8 +1472,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/securityLists/{securityListId}" method = "DELETE" @@ -1509,7 +1509,7 @@ def delete_subnet(self, subnet_id, **kwargs): """ DeleteSubnet Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous - operation; the subnet's `lifecycleState` will change to TERMINATING temporarily. If there are any + operation. The subnet's `lifecycleState` will change to TERMINATING temporarily. If there are any instances in the subnet, the state will instead change back to AVAILABLE. @@ -1521,8 +1521,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/subnets/{subnetId}" method = "DELETE" @@ -1558,7 +1558,7 @@ def delete_vcn(self, vcn_id, **kwargs): """ DeleteVcn Deletes the specified VCN. The VCN must be empty and have no attached gateways. This is an asynchronous - operation; the VCN's `lifecycleState` will change to TERMINATING temporarily until the VCN is completely + operation. The VCN's `lifecycleState` will change to TERMINATING temporarily until the VCN is completely removed. @@ -1570,8 +1570,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/vcns/{vcnId}" method = "DELETE" @@ -1621,8 +1621,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/virtualCircuits/{virtualCircuitId}" method = "DELETE" @@ -1663,8 +1663,8 @@ def get_cpe(self, cpe_id, **kwargs): :param str cpe_id: (required) The OCID of the CPE. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Cpe` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Cpe` + :rtype: :class:`~oci.response.Response` """ resource_path = "/cpes/{cpeId}" method = "GET" @@ -1699,8 +1699,8 @@ def get_cross_connect(self, cross_connect_id, **kwargs): :param str cross_connect_id: (required) The OCID of the cross-connect. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.CrossConnect` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnect` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnects/{crossConnectId}" method = "GET" @@ -1735,8 +1735,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.CrossConnectGroup` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnectGroup` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnectGroups/{crossConnectGroupId}" method = "GET" @@ -1771,8 +1771,8 @@ def get_cross_connect_letter_of_authority(self, cross_connect_id, **kwargs): :param str cross_connect_id: (required) The OCID of the cross-connect. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.LetterOfAuthority` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.LetterOfAuthority` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnects/{crossConnectId}/letterOfAuthority" method = "GET" @@ -1807,8 +1807,8 @@ def get_cross_connect_status(self, cross_connect_id, **kwargs): :param str cross_connect_id: (required) The OCID of the cross-connect. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.CrossConnectStatus` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnectStatus` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnects/{crossConnectId}/status" method = "GET" @@ -1843,8 +1843,8 @@ def get_dhcp_options(self, dhcp_id, **kwargs): :param str dhcp_id: (required) The OCID for the set of DHCP options. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.DhcpOptions` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DhcpOptions` + :rtype: :class:`~oci.response.Response` """ resource_path = "/dhcps/{dhcpId}" method = "GET" @@ -1879,8 +1879,8 @@ def get_drg(self, drg_id, **kwargs): :param str drg_id: (required) The OCID of the DRG. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Drg` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Drg` + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgs/{drgId}" method = "GET" @@ -1915,8 +1915,8 @@ def get_drg_attachment(self, drg_attachment_id, **kwargs): :param str drg_attachment_id: (required) The OCID of the DRG attachment. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.DrgAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DrgAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgAttachments/{drgAttachmentId}" method = "GET" @@ -1951,8 +1951,8 @@ def get_internet_gateway(self, ig_id, **kwargs): :param str ig_id: (required) The OCID of the Internet Gateway. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.InternetGateway` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InternetGateway` + :rtype: :class:`~oci.response.Response` """ resource_path = "/internetGateways/{igId}" method = "GET" @@ -1982,15 +1982,15 @@ def get_ip_sec_connection(self, ipsc_id, **kwargs): """ GetIPSecConnection Gets the specified IPSec connection's basic information, including the static routes for the - on-premise router. If you want the status of the connection (whether it's up or down), use + on-premises router. If you want the status of the connection (whether it's up or down), use :func:`get_ip_sec_connection_device_status`. :param str ipsc_id: (required) The OCID of the IPSec connection. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.IPSecConnection` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnection` + :rtype: :class:`~oci.response.Response` """ resource_path = "/ipsecConnections/{ipscId}" method = "GET" @@ -2026,8 +2026,8 @@ def get_ip_sec_connection_device_config(self, ipsc_id, **kwargs): :param str ipsc_id: (required) The OCID of the IPSec connection. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.IPSecConnectionDeviceConfig` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnectionDeviceConfig` + :rtype: :class:`~oci.response.Response` """ resource_path = "/ipsecConnections/{ipscId}/deviceConfig" method = "GET" @@ -2062,8 +2062,8 @@ def get_ip_sec_connection_device_status(self, ipsc_id, **kwargs): :param str ipsc_id: (required) The OCID of the IPSec connection. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.IPSecConnectionDeviceStatus` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnectionDeviceStatus` + :rtype: :class:`~oci.response.Response` """ resource_path = "/ipsecConnections/{ipscId}/deviceStatus" method = "GET" @@ -2101,8 +2101,8 @@ def get_private_ip(self, private_ip_id, **kwargs): :param str private_ip_id: (required) The private IP's OCID. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.PrivateIp` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PrivateIp` + :rtype: :class:`~oci.response.Response` """ resource_path = "/privateIps/{privateIpId}" method = "GET" @@ -2137,8 +2137,8 @@ def get_route_table(self, rt_id, **kwargs): :param str rt_id: (required) The OCID of the route table. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.RouteTable` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.RouteTable` + :rtype: :class:`~oci.response.Response` """ resource_path = "/routeTables/{rtId}" method = "GET" @@ -2173,8 +2173,8 @@ def get_security_list(self, security_list_id, **kwargs): :param str security_list_id: (required) The OCID of the security list. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.SecurityList` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.SecurityList` + :rtype: :class:`~oci.response.Response` """ resource_path = "/securityLists/{securityListId}" method = "GET" @@ -2209,8 +2209,8 @@ def get_subnet(self, subnet_id, **kwargs): :param str subnet_id: (required) The OCID of the subnet. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Subnet` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Subnet` + :rtype: :class:`~oci.response.Response` """ resource_path = "/subnets/{subnetId}" method = "GET" @@ -2245,8 +2245,8 @@ def get_vcn(self, vcn_id, **kwargs): :param str vcn_id: (required) The OCID of the VCN. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Vcn` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vcn` + :rtype: :class:`~oci.response.Response` """ resource_path = "/vcns/{vcnId}" method = "GET" @@ -2281,8 +2281,8 @@ def get_virtual_circuit(self, virtual_circuit_id, **kwargs): :param str virtual_circuit_id: (required) The OCID of the virtual circuit. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VirtualCircuit` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VirtualCircuit` + :rtype: :class:`~oci.response.Response` """ resource_path = "/virtualCircuits/{virtualCircuitId}" method = "GET" @@ -2320,8 +2320,8 @@ def get_vnic(self, vnic_id, **kwargs): :param str vnic_id: (required) The OCID of the VNIC. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Vnic` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vnic` + :rtype: :class:`~oci.response.Response` """ resource_path = "/vnics/{vnicId}" method = "GET" @@ -2364,8 +2364,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.Cpe` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Cpe` + :rtype: :class:`~oci.response.Response` """ resource_path = "/cpes" method = "GET" @@ -2416,8 +2416,8 @@ def list_cross_connect_groups(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.CrossConnectGroup` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.CrossConnectGroup` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnectGroups" method = "GET" @@ -2469,8 +2469,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.CrossConnectLocation` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.CrossConnectLocation` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnectLocations" method = "GET" @@ -2525,8 +2525,8 @@ def list_cross_connects(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.CrossConnect` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.CrossConnect` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnects" method = "GET" @@ -2566,7 +2566,7 @@ def list_crossconnect_port_speed_shapes(self, compartment_id, **kwargs): """ ListCrossConnectPortSpeedShapes Lists the available port speeds for cross-connects. You need this information - so you can specify your desired port speed (i.e., shape) when you create a + so you can specify your desired port speed (that is, shape) when you create a cross-connect. @@ -2581,8 +2581,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.CrossConnectPortSpeedShape` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.CrossConnectPortSpeedShape` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnectPortSpeedShapes" method = "GET" @@ -2638,8 +2638,8 @@ def list_dhcp_options(self, compartment_id, vcn_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.DhcpOptions` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.DhcpOptions` + :rtype: :class:`~oci.response.Response` """ resource_path = "/dhcps" method = "GET" @@ -2698,8 +2698,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.DrgAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.DrgAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgAttachments" method = "GET" @@ -2754,8 +2754,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.Drg` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Drg` + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgs" method = "GET" @@ -2814,8 +2814,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.FastConnectProviderService` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.FastConnectProviderService` + :rtype: :class:`~oci.response.Response` """ resource_path = "/fastConnectProviderServices" method = "GET" @@ -2869,8 +2869,8 @@ def list_internet_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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.InternetGateway` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.InternetGateway` + :rtype: :class:`~oci.response.Response` """ resource_path = "/internetGateways" method = "GET" @@ -2929,8 +2929,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.IPSecConnection` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.IPSecConnection` + :rtype: :class:`~oci.response.Response` """ resource_path = "/ipsecConnections" method = "GET" @@ -3005,8 +3005,8 @@ def list_private_ips(self, **kwargs): :param str vnic_id: (optional) The OCID of the VNIC. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.PrivateIp` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.PrivateIp` + :rtype: :class:`~oci.response.Response` """ resource_path = "/privateIps" method = "GET" @@ -3067,8 +3067,8 @@ def list_route_tables(self, compartment_id, vcn_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.RouteTable` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.RouteTable` + :rtype: :class:`~oci.response.Response` """ resource_path = "/routeTables" method = "GET" @@ -3123,8 +3123,8 @@ def list_security_lists(self, compartment_id, vcn_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.SecurityList` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.SecurityList` + :rtype: :class:`~oci.response.Response` """ resource_path = "/securityLists" method = "GET" @@ -3179,8 +3179,8 @@ def list_subnets(self, compartment_id, vcn_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.Subnet` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Subnet` + :rtype: :class:`~oci.response.Response` """ resource_path = "/subnets" method = "GET" @@ -3232,8 +3232,8 @@ def list_vcns(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.Vcn` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.Vcn` + :rtype: :class:`~oci.response.Response` """ resource_path = "/vcns" method = "GET" @@ -3271,7 +3271,7 @@ def list_virtual_circuit_bandwidth_shapes(self, compartment_id, **kwargs): """ ListVirtualCircuitBandwidthShapes Lists the available bandwidth levels for virtual circuits. You need this - information so you can specify your desired bandwidth level (i.e., shape) + information so you can specify your desired bandwidth level (that is, shape) when you create a virtual circuit. For the compartment ID, provide the OCID of your tenancy (the root compartment). @@ -3293,8 +3293,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.VirtualCircuitBandwidthShape` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VirtualCircuitBandwidthShape` + :rtype: :class:`~oci.response.Response` """ resource_path = "/virtualCircuitBandwidthShapes" method = "GET" @@ -3345,8 +3345,8 @@ def list_virtual_circuits(self, compartment_id, **kwargs): :param str page: (optional) The value of the `opc-next-page` response header from the previous \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.core.models.VirtualCircuit` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.VirtualCircuit` + :rtype: :class:`~oci.response.Response` """ resource_path = "/virtualCircuits" method = "GET" @@ -3398,8 +3398,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Cpe` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Cpe` + :rtype: :class:`~oci.response.Response` """ resource_path = "/cpes/{cpeId}" method = "PUT" @@ -3450,8 +3450,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.CrossConnect` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnect` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnects/{crossConnectId}" method = "PUT" @@ -3503,8 +3503,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.CrossConnectGroup` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.CrossConnectGroup` + :rtype: :class:`~oci.response.Response` """ resource_path = "/crossConnectGroups/{crossConnectGroupId}" method = "PUT" @@ -3558,8 +3558,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.DhcpOptions` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DhcpOptions` + :rtype: :class:`~oci.response.Response` """ resource_path = "/dhcps/{dhcpId}" method = "PUT" @@ -3610,8 +3610,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Drg` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Drg` + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgs/{drgId}" method = "PUT" @@ -3663,8 +3663,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.DrgAttachment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.DrgAttachment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/drgAttachments/{drgAttachmentId}" method = "PUT" @@ -3719,8 +3719,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.InternetGateway` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.InternetGateway` + :rtype: :class:`~oci.response.Response` """ resource_path = "/internetGateways/{igId}" method = "PUT" @@ -3772,8 +3772,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.IPSecConnection` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnection` + :rtype: :class:`~oci.response.Response` """ resource_path = "/ipsecConnections/{ipscId}" method = "PUT" @@ -3833,8 +3833,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.PrivateIp` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.PrivateIp` + :rtype: :class:`~oci.response.Response` """ resource_path = "/privateIps/{privateIpId}" method = "PUT" @@ -3888,8 +3888,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.RouteTable` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.RouteTable` + :rtype: :class:`~oci.response.Response` """ resource_path = "/routeTables/{rtId}" method = "PUT" @@ -3944,8 +3944,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.SecurityList` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.SecurityList` + :rtype: :class:`~oci.response.Response` """ resource_path = "/securityLists/{securityListId}" method = "PUT" @@ -3996,8 +3996,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Subnet` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Subnet` + :rtype: :class:`~oci.response.Response` """ resource_path = "/subnets/{subnetId}" method = "PUT" @@ -4049,8 +4049,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Vcn` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vcn` + :rtype: :class:`~oci.response.Response` """ resource_path = "/vcns/{vcnId}" method = "PUT" @@ -4096,7 +4096,7 @@ def update_virtual_circuit(self, virtual_circuit_id, update_virtual_circuit_deta **Important:** If the virtual circuit is working and in the PROVISIONED state, updating any of the network-related properties - (such as the DRG being used, the BGP ASN, etc.) will cause the virtual + (such as the DRG being used, the BGP ASN, and so on) will cause the virtual circuit's state to switch to PROVISIONING and the related BGP session to go down. After Oracle re-provisions the virtual circuit, its state will return to PROVISIONED. Make sure you confirm that @@ -4118,8 +4118,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.VirtualCircuit` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.VirtualCircuit` + :rtype: :class:`~oci.response.Response` """ resource_path = "/virtualCircuits/{virtualCircuitId}" method = "PUT" @@ -4170,8 +4170,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.core.models.Vnic` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.Vnic` + :rtype: :class:`~oci.response.Response` """ resource_path = "/vnics/{vnicId}" method = "PUT" diff --git a/src/oci/database/__init__.py b/src/oci/database/__init__.py new file mode 100644 index 0000000000..636d1fbdf6 --- /dev/null +++ b/src/oci/database/__init__.py @@ -0,0 +1,10 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + +from __future__ import absolute_import + + +from .database_client import DatabaseClient +from . import models + +__all__ = ["DatabaseClient", "models"] diff --git a/src/oci/database/database_client.py b/src/oci/database/database_client.py new file mode 100644 index 0000000000..a22efa1b14 --- /dev/null +++ b/src/oci/database/database_client.py @@ -0,0 +1,820 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + +from __future__ import absolute_import + +import six + +from ..base_client import BaseClient +from ..config import get_config_value_or_default, validate_config +from ..signer import Signer +from ..util import Sentinel +from .models import database_type_mapping +missing = Sentinel("Missing") + + +class DatabaseClient(object): + + def __init__(self, config): + validate_config(config) + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config["key_file"], + pass_phrase=get_config_value_or_default(config, "pass_phrase") + ) + self.base_client = BaseClient("database", config, signer, database_type_mapping) + + def create_db_home(self, create_db_home_with_db_system_id_details, **kwargs): + """ + createDbHome + Creates a new DB Home in the specified DB System based on the request parameters you provide. + + + :param CreateDbHomeWithDbSystemIdDetails create_db_home_with_db_system_id_details: (required) + Request to create a new DB Home. + + :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). + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbHome` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbHomes" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "opc_retry_token" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_db_home got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "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} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_db_home_with_db_system_id_details, + response_type="DbHome") + + def db_node_action(self, db_node_id, action, **kwargs): + """ + DbNodeAction + Performs an action, such as one of the power actions (start, stop, softreset, or reset), on the specified DB Node. + + **start** - power on + + **stop** - power off + + **softreset** - ACPI shutdown and power on + + **reset** - power off and power on + + Note that the **stop** state has no effect on the resources you consume. + Billing continues for DB Nodes that you stop, and related resources continue + to apply against any relevant quotas. You must terminate the DB System + (:func:`terminate_db_system`) + to remove its resources from billing and quotas. + + + :param str db_node_id: (required) + The database node OCID. + + :param str action: (required) + The action to perform on the DB Node. + + :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 str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbNode` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbNodes/{dbNodeId}" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "opc_retry_token", + "if_match" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "db_node_action got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "dbNodeId": db_node_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + query_params = { + "action": action + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="DbNode") + + def delete_db_home(self, db_home_id, **kwargs): + """ + DeleteDbHome + Deletes a DB Home. The DB Home and its database data are local to the DB System and will be lost when it is deleted. Oracle recommends that you back up any data in the DB System prior to deleting it. + + + :param str db_home_id: (required) + The database home OCID. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbHomes/{dbHomeId}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "if_match" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_db_home got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "dbHomeId": db_home_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def get_database(self, database_id, **kwargs): + """ + GetDatabase + Gets information about a specific database. + + + :param str database_id: (required) + The database OCID. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.Database` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/databases/{databaseId}" + method = "GET" + + if kwargs: + raise ValueError( + "get_database got unknown kwargs: {!r}".format(kwargs)) + + path_params = { + "databaseId": database_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Database") + + def get_db_home(self, db_home_id, **kwargs): + """ + GetDbHome + Gets information about the specified database home. + + + :param str db_home_id: (required) + The database home OCID. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbHome` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbHomes/{dbHomeId}" + method = "GET" + + if kwargs: + raise ValueError( + "get_db_home got unknown kwargs: {!r}".format(kwargs)) + + path_params = { + "dbHomeId": db_home_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="DbHome") + + def get_db_node(self, db_node_id, **kwargs): + """ + GetDbNode + Gets information about the specified database node. + + + :param str db_node_id: (required) + The database node OCID. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbNode` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbNodes/{dbNodeId}" + method = "GET" + + if kwargs: + raise ValueError( + "get_db_node got unknown kwargs: {!r}".format(kwargs)) + + path_params = { + "dbNodeId": db_node_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="DbNode") + + def get_db_system(self, db_system_id, **kwargs): + """ + GetDbSystem + Gets information about the specified DB System. + + + :param str db_system_id: (required) + The DB System OCID. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbSystem` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbSystems/{dbSystemId}" + method = "GET" + + if kwargs: + raise ValueError( + "get_db_system got unknown kwargs: {!r}".format(kwargs)) + + path_params = { + "dbSystemId": db_system_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="DbSystem") + + def launch_db_system(self, launch_db_system_details, **kwargs): + """ + LaunchDbSystem + Launches a new DB System in the specified compartment and Availability Domain. You'll specify a single Oracle + Database Edition that applies to all the databases on that DB System. The selected edition cannot be changed. + + An initial database is created on the DB System based on the request parameters you provide and some default + options. For more information, + see `Default Options for the Initial Database`__. + + The DB System will include a command line interface (CLI) that you can use to create additional databases and + manage existing databases. For more information, see the + `Oracle Database CLI Reference`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Tasks/launchingDB.htm#Default_Options_for_the_Initial_Database + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/References/odacli.htm#Oracle_Database_CLI_Reference + + + :param LaunchDbSystemDetails launch_db_system_details: (required) + Request to launch a DB System. + + :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). + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbSystem` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbSystems" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "opc_retry_token" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "launch_db_system got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "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} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=launch_db_system_details, + response_type="DbSystem") + + def list_databases(self, compartment_id, db_home_id, **kwargs): + """ + ListDatabases + Gets a list of the databases in the specified database home. + + + :param str compartment_id: (required) + The compartment OCID. + + :param str db_home_id: (required) + A database home OCID. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The pagination token to continue listing from. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DatabaseSummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/databases" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "limit", + "page" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_databases got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "compartmentId": compartment_id, + "dbHomeId": db_home_id, + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[DatabaseSummary]") + + def list_db_homes(self, compartment_id, db_system_id, **kwargs): + """ + ListDbHomes + Gets a list of database homes in the specified DB System and compartment. A database home is a directory where Oracle database software is installed. + + + :param str compartment_id: (required) + The compartment OCID. + + :param str db_system_id: (required) + The OCID of the DB System. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The pagination token to continue listing from. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbHomeSummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbHomes" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "limit", + "page" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_db_homes got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "compartmentId": compartment_id, + "dbSystemId": db_system_id, + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[DbHomeSummary]") + + def list_db_nodes(self, compartment_id, db_system_id, **kwargs): + """ + ListDbNodes + Gets a list of database nodes in the specified DB System and compartment. A database node is a server running database software. + + + :param str compartment_id: (required) + The compartment OCID. + + :param str db_system_id: (required) + The OCID of the DB System. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The pagination token to continue listing from. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbNodeSummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbNodes" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "limit", + "page" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_db_nodes got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "compartmentId": compartment_id, + "dbSystemId": db_system_id, + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[DbNodeSummary]") + + def list_db_system_shapes(self, availability_domain, compartment_id, **kwargs): + """ + ListDbSystemShapes + Gets a list of the shapes that can be used to launch a new DB System. The shape determines the CPU cores, storage, and memory allocated to the DB System. + + + :param str availability_domain: (required) + The name of the Availability Domain. + + :param str compartment_id: (required) + The compartment OCID. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The pagination token to continue listing from. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbSystemShapeSummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbSystemShapes" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "limit", + "page" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_db_system_shapes got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "availabilityDomain": availability_domain, + "compartmentId": compartment_id, + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[DbSystemShapeSummary]") + + def list_db_systems(self, compartment_id, **kwargs): + """ + ListDbSystems + Gets a list of the DB Systems in the specified compartment. + + + :param str compartment_id: (required) + The compartment OCID. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The pagination token to continue listing from. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbSystemSummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbSystems" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "limit", + "page" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_db_systems got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "compartmentId": compartment_id, + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[DbSystemSummary]") + + def list_db_versions(self, compartment_id, **kwargs): + """ + ListDbVersions + Gets a list of supported Oracle database versions. + + + :param str compartment_id: (required) + The compartment OCID. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The pagination token to continue listing from. + + :param str db_system_shape: (optional) + If provided, filters the results to the set of database versions which are supported for the given shape. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.database.models.DbVersionSummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbVersions" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "limit", + "page", + "db_system_shape" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_db_versions got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "compartmentId": compartment_id, + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "dbSystemShape": kwargs.get("db_system_shape", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[DbVersionSummary]") + + def terminate_db_system(self, db_system_id, **kwargs): + """ + TerminateDbSystem + Terminates a DB System and permanently deletes it and any databases running on it. The database data is local to the DB System and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB System prior to terminating it. + + + :param str db_system_id: (required) + The DB System OCID. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbSystems/{dbSystemId}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "if_match" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "terminate_db_system got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "dbSystemId": db_system_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def update_db_system(self, db_system_id, update_db_system_details, **kwargs): + """ + UpdateDbSystem + Updates the properties of a DB System, such as the CPU core count. + + + :param str db_system_id: (required) + The DB System OCID. + + :param UpdateDbSystemDetails update_db_system_details: (required) + Request to update the properties of a DB System. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database.models.DbSystem` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/dbSystems/{dbSystemId}" + method = "PUT" + + # Don't accept unknown kwargs + expected_kwargs = [ + "if_match" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_db_system got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "dbSystemId": db_system_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_db_system_details, + response_type="DbSystem") diff --git a/src/oci/database/models/__init__.py b/src/oci/database/models/__init__.py new file mode 100644 index 0000000000..d298146eb8 --- /dev/null +++ b/src/oci/database/models/__init__.py @@ -0,0 +1,39 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + +from __future__ import absolute_import + +from .create_database_details import CreateDatabaseDetails +from .create_db_home_details import CreateDbHomeDetails +from .create_db_home_with_db_system_id_details import CreateDbHomeWithDbSystemIdDetails +from .database import Database +from .database_summary import DatabaseSummary +from .db_home import DbHome +from .db_home_summary import DbHomeSummary +from .db_node import DbNode +from .db_node_summary import DbNodeSummary +from .db_system import DbSystem +from .db_system_shape_summary import DbSystemShapeSummary +from .db_system_summary import DbSystemSummary +from .db_version_summary import DbVersionSummary +from .launch_db_system_details import LaunchDbSystemDetails +from .update_db_system_details import UpdateDbSystemDetails + +# Maps type names to classes for database services. +database_type_mapping = { + "CreateDatabaseDetails": CreateDatabaseDetails, + "CreateDbHomeDetails": CreateDbHomeDetails, + "CreateDbHomeWithDbSystemIdDetails": CreateDbHomeWithDbSystemIdDetails, + "Database": Database, + "DatabaseSummary": DatabaseSummary, + "DbHome": DbHome, + "DbHomeSummary": DbHomeSummary, + "DbNode": DbNode, + "DbNodeSummary": DbNodeSummary, + "DbSystem": DbSystem, + "DbSystemShapeSummary": DbSystemShapeSummary, + "DbSystemSummary": DbSystemSummary, + "DbVersionSummary": DbVersionSummary, + "LaunchDbSystemDetails": LaunchDbSystemDetails, + "UpdateDbSystemDetails": UpdateDbSystemDetails +} diff --git a/src/oci/database/models/create_database_details.py b/src/oci/database/models/create_database_details.py new file mode 100644 index 0000000000..d91d5978fa --- /dev/null +++ b/src/oci/database/models/create_database_details.py @@ -0,0 +1,205 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class CreateDatabaseDetails(object): + + def __init__(self): + + self.swagger_types = { + 'admin_password': 'str', + 'character_set': 'str', + 'db_name': 'str', + 'db_workload': 'str', + 'ncharacter_set': 'str', + 'pdb_name': 'str' + } + + self.attribute_map = { + 'admin_password': 'adminPassword', + 'character_set': 'characterSet', + 'db_name': 'dbName', + 'db_workload': 'dbWorkload', + 'ncharacter_set': 'ncharacterSet', + 'pdb_name': 'pdbName' + } + + self._admin_password = None + self._character_set = None + self._db_name = None + self._db_workload = None + self._ncharacter_set = None + self._pdb_name = None + + @property + def admin_password(self): + """ + Gets the admin_password of this CreateDatabaseDetails. + A strong password for SYS, SYSTEM, and PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \\#, or -. + + + :return: The admin_password of this CreateDatabaseDetails. + :rtype: str + """ + return self._admin_password + + @admin_password.setter + def admin_password(self, admin_password): + """ + Sets the admin_password of this CreateDatabaseDetails. + A strong password for SYS, SYSTEM, and PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \\#, or -. + + + :param admin_password: The admin_password of this CreateDatabaseDetails. + :type: str + """ + self._admin_password = admin_password + + @property + def character_set(self): + """ + Gets the character_set of this CreateDatabaseDetails. + The character set for the database. The default is AL32UTF8. Allowed values are: + + AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS + + + :return: The character_set of this CreateDatabaseDetails. + :rtype: str + """ + return self._character_set + + @character_set.setter + def character_set(self, character_set): + """ + Sets the character_set of this CreateDatabaseDetails. + The character set for the database. The default is AL32UTF8. Allowed values are: + + AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS + + + :param character_set: The character_set of this CreateDatabaseDetails. + :type: str + """ + self._character_set = character_set + + @property + def db_name(self): + """ + Gets the db_name of this CreateDatabaseDetails. + The database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. + + + :return: The db_name of this CreateDatabaseDetails. + :rtype: str + """ + return self._db_name + + @db_name.setter + def db_name(self, db_name): + """ + Sets the db_name of this CreateDatabaseDetails. + The database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. + + + :param db_name: The db_name of this CreateDatabaseDetails. + :type: str + """ + self._db_name = db_name + + @property + def db_workload(self): + """ + Gets the db_workload of this CreateDatabaseDetails. + Database workload type. + + Allowed values for this property are: "OLTP", "DSS" + + + :return: The db_workload of this CreateDatabaseDetails. + :rtype: str + """ + return self._db_workload + + @db_workload.setter + def db_workload(self, db_workload): + """ + Sets the db_workload of this CreateDatabaseDetails. + Database workload type. + + + :param db_workload: The db_workload of this CreateDatabaseDetails. + :type: str + """ + allowed_values = ["OLTP", "DSS"] + if db_workload not in allowed_values: + raise ValueError( + "Invalid value for `db_workload`, must be one of {0}" + .format(allowed_values) + ) + self._db_workload = db_workload + + @property + def ncharacter_set(self): + """ + Gets the ncharacter_set of this CreateDatabaseDetails. + National character set for the database. The default is AL16UTF16. Allowed values are: + AL16UTF16 or UTF8. + + + :return: The ncharacter_set of this CreateDatabaseDetails. + :rtype: str + """ + return self._ncharacter_set + + @ncharacter_set.setter + def ncharacter_set(self, ncharacter_set): + """ + Sets the ncharacter_set of this CreateDatabaseDetails. + National character set for the database. The default is AL16UTF16. Allowed values are: + AL16UTF16 or UTF8. + + + :param ncharacter_set: The ncharacter_set of this CreateDatabaseDetails. + :type: str + """ + self._ncharacter_set = ncharacter_set + + @property + def pdb_name(self): + """ + Gets the pdb_name of this CreateDatabaseDetails. + Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + + + :return: The pdb_name of this CreateDatabaseDetails. + :rtype: str + """ + return self._pdb_name + + @pdb_name.setter + def pdb_name(self, pdb_name): + """ + Sets the pdb_name of this CreateDatabaseDetails. + Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + + + :param pdb_name: The pdb_name of this CreateDatabaseDetails. + :type: str + """ + self._pdb_name = pdb_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/database/models/create_db_home_details.py b/src/oci/database/models/create_db_home_details.py new file mode 100644 index 0000000000..21f3d62c12 --- /dev/null +++ b/src/oci/database/models/create_db_home_details.py @@ -0,0 +1,106 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class CreateDbHomeDetails(object): + + def __init__(self): + + self.swagger_types = { + 'database': 'CreateDatabaseDetails', + 'db_version': 'str', + 'display_name': 'str' + } + + self.attribute_map = { + 'database': 'database', + 'db_version': 'dbVersion', + 'display_name': 'displayName' + } + + self._database = None + self._db_version = None + self._display_name = None + + @property + def database(self): + """ + Gets the database of this CreateDbHomeDetails. + + :return: The database of this CreateDbHomeDetails. + :rtype: CreateDatabaseDetails + """ + return self._database + + @database.setter + def database(self, database): + """ + Sets the database of this CreateDbHomeDetails. + + :param database: The database of this CreateDbHomeDetails. + :type: CreateDatabaseDetails + """ + self._database = database + + @property + def db_version(self): + """ + Gets the db_version of this CreateDbHomeDetails. + A valid Oracle database version. To get a list of supported versions, use the :func:`list_db_versions` operation. + + + :return: The db_version of this CreateDbHomeDetails. + :rtype: str + """ + return self._db_version + + @db_version.setter + def db_version(self, db_version): + """ + Sets the db_version of this CreateDbHomeDetails. + A valid Oracle database version. To get a list of supported versions, use the :func:`list_db_versions` operation. + + + :param db_version: The db_version of this CreateDbHomeDetails. + :type: str + """ + self._db_version = db_version + + @property + def display_name(self): + """ + Gets the display_name of this CreateDbHomeDetails. + The user-provided name of the database home. + + + :return: The display_name of this CreateDbHomeDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateDbHomeDetails. + The user-provided name of the database home. + + + :param display_name: The display_name of this CreateDbHomeDetails. + :type: str + """ + self._display_name = display_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/database/models/create_db_home_with_db_system_id_details.py b/src/oci/database/models/create_db_home_with_db_system_id_details.py new file mode 100644 index 0000000000..62c0f1ac7e --- /dev/null +++ b/src/oci/database/models/create_db_home_with_db_system_id_details.py @@ -0,0 +1,133 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class CreateDbHomeWithDbSystemIdDetails(object): + + def __init__(self): + + self.swagger_types = { + 'database': 'CreateDatabaseDetails', + 'db_system_id': 'str', + 'db_version': 'str', + 'display_name': 'str' + } + + self.attribute_map = { + 'database': 'database', + 'db_system_id': 'dbSystemId', + 'db_version': 'dbVersion', + 'display_name': 'displayName' + } + + self._database = None + self._db_system_id = None + self._db_version = None + self._display_name = None + + @property + def database(self): + """ + Gets the database of this CreateDbHomeWithDbSystemIdDetails. + + :return: The database of this CreateDbHomeWithDbSystemIdDetails. + :rtype: CreateDatabaseDetails + """ + return self._database + + @database.setter + def database(self, database): + """ + Sets the database of this CreateDbHomeWithDbSystemIdDetails. + + :param database: The database of this CreateDbHomeWithDbSystemIdDetails. + :type: CreateDatabaseDetails + """ + self._database = database + + @property + def db_system_id(self): + """ + Gets the db_system_id of this CreateDbHomeWithDbSystemIdDetails. + The OCID of the DB System. + + + :return: The db_system_id of this CreateDbHomeWithDbSystemIdDetails. + :rtype: str + """ + return self._db_system_id + + @db_system_id.setter + def db_system_id(self, db_system_id): + """ + Sets the db_system_id of this CreateDbHomeWithDbSystemIdDetails. + The OCID of the DB System. + + + :param db_system_id: The db_system_id of this CreateDbHomeWithDbSystemIdDetails. + :type: str + """ + self._db_system_id = db_system_id + + @property + def db_version(self): + """ + Gets the db_version of this CreateDbHomeWithDbSystemIdDetails. + A valid Oracle database version. To get a list of supported versions, use the :func:`list_db_versions` operation. + + + :return: The db_version of this CreateDbHomeWithDbSystemIdDetails. + :rtype: str + """ + return self._db_version + + @db_version.setter + def db_version(self, db_version): + """ + Sets the db_version of this CreateDbHomeWithDbSystemIdDetails. + A valid Oracle database version. To get a list of supported versions, use the :func:`list_db_versions` operation. + + + :param db_version: The db_version of this CreateDbHomeWithDbSystemIdDetails. + :type: str + """ + self._db_version = db_version + + @property + def display_name(self): + """ + Gets the display_name of this CreateDbHomeWithDbSystemIdDetails. + The user-provided name of the database home. + + + :return: The display_name of this CreateDbHomeWithDbSystemIdDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateDbHomeWithDbSystemIdDetails. + The user-provided name of the database home. + + + :param display_name: The display_name of this CreateDbHomeWithDbSystemIdDetails. + :type: str + """ + self._display_name = display_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/database/models/database.py b/src/oci/database/models/database.py new file mode 100644 index 0000000000..374da76f57 --- /dev/null +++ b/src/oci/database/models/database.py @@ -0,0 +1,359 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class Database(object): + + def __init__(self): + + self.swagger_types = { + 'character_set': 'str', + 'compartment_id': 'str', + 'db_home_id': 'str', + 'db_name': 'str', + 'db_unique_name': 'str', + 'db_workload': 'str', + 'id': 'str', + 'lifecycle_details': 'str', + 'lifecycle_state': 'str', + 'ncharacter_set': 'str', + 'pdb_name': 'str', + 'time_created': 'datetime' + } + + self.attribute_map = { + 'character_set': 'characterSet', + 'compartment_id': 'compartmentId', + 'db_home_id': 'dbHomeId', + 'db_name': 'dbName', + 'db_unique_name': 'dbUniqueName', + 'db_workload': 'dbWorkload', + 'id': 'id', + 'lifecycle_details': 'lifecycleDetails', + 'lifecycle_state': 'lifecycleState', + 'ncharacter_set': 'ncharacterSet', + 'pdb_name': 'pdbName', + 'time_created': 'timeCreated' + } + + self._character_set = None + self._compartment_id = None + self._db_home_id = None + self._db_name = None + self._db_unique_name = None + self._db_workload = None + self._id = None + self._lifecycle_details = None + self._lifecycle_state = None + self._ncharacter_set = None + self._pdb_name = None + self._time_created = None + + @property + def character_set(self): + """ + Gets the character_set of this Database. + The character set for the database. + + + :return: The character_set of this Database. + :rtype: str + """ + return self._character_set + + @character_set.setter + def character_set(self, character_set): + """ + Sets the character_set of this Database. + The character set for the database. + + + :param character_set: The character_set of this Database. + :type: str + """ + self._character_set = character_set + + @property + def compartment_id(self): + """ + Gets the compartment_id of this Database. + The OCID of the compartment. + + + :return: The compartment_id of this Database. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this Database. + The OCID of the compartment. + + + :param compartment_id: The compartment_id of this Database. + :type: str + """ + self._compartment_id = compartment_id + + @property + def db_home_id(self): + """ + Gets the db_home_id of this Database. + The OCID of the database home. + + + :return: The db_home_id of this Database. + :rtype: str + """ + return self._db_home_id + + @db_home_id.setter + def db_home_id(self, db_home_id): + """ + Sets the db_home_id of this Database. + The OCID of the database home. + + + :param db_home_id: The db_home_id of this Database. + :type: str + """ + self._db_home_id = db_home_id + + @property + def db_name(self): + """ + Gets the db_name of this Database. + The database name. + + + :return: The db_name of this Database. + :rtype: str + """ + return self._db_name + + @db_name.setter + def db_name(self, db_name): + """ + Sets the db_name of this Database. + The database name. + + + :param db_name: The db_name of this Database. + :type: str + """ + self._db_name = db_name + + @property + def db_unique_name(self): + """ + Gets the db_unique_name of this Database. + A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. + + + :return: The db_unique_name of this Database. + :rtype: str + """ + return self._db_unique_name + + @db_unique_name.setter + def db_unique_name(self, db_unique_name): + """ + Sets the db_unique_name of this Database. + A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. + + + :param db_unique_name: The db_unique_name of this Database. + :type: str + """ + self._db_unique_name = db_unique_name + + @property + def db_workload(self): + """ + Gets the db_workload of this Database. + Database workload type. + + + :return: The db_workload of this Database. + :rtype: str + """ + return self._db_workload + + @db_workload.setter + def db_workload(self, db_workload): + """ + Sets the db_workload of this Database. + Database workload type. + + + :param db_workload: The db_workload of this Database. + :type: str + """ + self._db_workload = db_workload + + @property + def id(self): + """ + Gets the id of this Database. + The OCID of the database. + + + :return: The id of this Database. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Database. + The OCID of the database. + + + :param id: The id of this Database. + :type: str + """ + self._id = id + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this Database. + Additional information about the current lifecycleState. + + + :return: The lifecycle_details of this Database. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this Database. + Additional information about the current lifecycleState. + + + :param lifecycle_details: The lifecycle_details of this Database. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this Database. + The current state of the database. + + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this Database. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this Database. + The current state of the database. + + + :param lifecycle_state: The lifecycle_state of this Database. + :type: str + """ + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def ncharacter_set(self): + """ + Gets the ncharacter_set of this Database. + The national character set for the database. + + + :return: The ncharacter_set of this Database. + :rtype: str + """ + return self._ncharacter_set + + @ncharacter_set.setter + def ncharacter_set(self, ncharacter_set): + """ + Sets the ncharacter_set of this Database. + The national character set for the database. + + + :param ncharacter_set: The ncharacter_set of this Database. + :type: str + """ + self._ncharacter_set = ncharacter_set + + @property + def pdb_name(self): + """ + Gets the pdb_name of this Database. + Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + + + :return: The pdb_name of this Database. + :rtype: str + """ + return self._pdb_name + + @pdb_name.setter + def pdb_name(self, pdb_name): + """ + Sets the pdb_name of this Database. + Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + + + :param pdb_name: The pdb_name of this Database. + :type: str + """ + self._pdb_name = pdb_name + + @property + def time_created(self): + """ + Gets the time_created of this Database. + The date and time the database was created. + + + :return: The time_created of this Database. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this Database. + The date and time the database was created. + + + :param time_created: The time_created of this Database. + :type: datetime + """ + self._time_created = time_created + + 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/database/models/database_summary.py b/src/oci/database/models/database_summary.py new file mode 100644 index 0000000000..0030277cca --- /dev/null +++ b/src/oci/database/models/database_summary.py @@ -0,0 +1,359 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class DatabaseSummary(object): + + def __init__(self): + + self.swagger_types = { + 'character_set': 'str', + 'compartment_id': 'str', + 'db_home_id': 'str', + 'db_name': 'str', + 'db_unique_name': 'str', + 'db_workload': 'str', + 'id': 'str', + 'lifecycle_details': 'str', + 'lifecycle_state': 'str', + 'ncharacter_set': 'str', + 'pdb_name': 'str', + 'time_created': 'datetime' + } + + self.attribute_map = { + 'character_set': 'characterSet', + 'compartment_id': 'compartmentId', + 'db_home_id': 'dbHomeId', + 'db_name': 'dbName', + 'db_unique_name': 'dbUniqueName', + 'db_workload': 'dbWorkload', + 'id': 'id', + 'lifecycle_details': 'lifecycleDetails', + 'lifecycle_state': 'lifecycleState', + 'ncharacter_set': 'ncharacterSet', + 'pdb_name': 'pdbName', + 'time_created': 'timeCreated' + } + + self._character_set = None + self._compartment_id = None + self._db_home_id = None + self._db_name = None + self._db_unique_name = None + self._db_workload = None + self._id = None + self._lifecycle_details = None + self._lifecycle_state = None + self._ncharacter_set = None + self._pdb_name = None + self._time_created = None + + @property + def character_set(self): + """ + Gets the character_set of this DatabaseSummary. + The character set for the database. + + + :return: The character_set of this DatabaseSummary. + :rtype: str + """ + return self._character_set + + @character_set.setter + def character_set(self, character_set): + """ + Sets the character_set of this DatabaseSummary. + The character set for the database. + + + :param character_set: The character_set of this DatabaseSummary. + :type: str + """ + self._character_set = character_set + + @property + def compartment_id(self): + """ + Gets the compartment_id of this DatabaseSummary. + The OCID of the compartment. + + + :return: The compartment_id of this DatabaseSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this DatabaseSummary. + The OCID of the compartment. + + + :param compartment_id: The compartment_id of this DatabaseSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def db_home_id(self): + """ + Gets the db_home_id of this DatabaseSummary. + The OCID of the database home. + + + :return: The db_home_id of this DatabaseSummary. + :rtype: str + """ + return self._db_home_id + + @db_home_id.setter + def db_home_id(self, db_home_id): + """ + Sets the db_home_id of this DatabaseSummary. + The OCID of the database home. + + + :param db_home_id: The db_home_id of this DatabaseSummary. + :type: str + """ + self._db_home_id = db_home_id + + @property + def db_name(self): + """ + Gets the db_name of this DatabaseSummary. + The database name. + + + :return: The db_name of this DatabaseSummary. + :rtype: str + """ + return self._db_name + + @db_name.setter + def db_name(self, db_name): + """ + Sets the db_name of this DatabaseSummary. + The database name. + + + :param db_name: The db_name of this DatabaseSummary. + :type: str + """ + self._db_name = db_name + + @property + def db_unique_name(self): + """ + Gets the db_unique_name of this DatabaseSummary. + A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. + + + :return: The db_unique_name of this DatabaseSummary. + :rtype: str + """ + return self._db_unique_name + + @db_unique_name.setter + def db_unique_name(self, db_unique_name): + """ + Sets the db_unique_name of this DatabaseSummary. + A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. + + + :param db_unique_name: The db_unique_name of this DatabaseSummary. + :type: str + """ + self._db_unique_name = db_unique_name + + @property + def db_workload(self): + """ + Gets the db_workload of this DatabaseSummary. + Database workload type. + + + :return: The db_workload of this DatabaseSummary. + :rtype: str + """ + return self._db_workload + + @db_workload.setter + def db_workload(self, db_workload): + """ + Sets the db_workload of this DatabaseSummary. + Database workload type. + + + :param db_workload: The db_workload of this DatabaseSummary. + :type: str + """ + self._db_workload = db_workload + + @property + def id(self): + """ + Gets the id of this DatabaseSummary. + The OCID of the database. + + + :return: The id of this DatabaseSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this DatabaseSummary. + The OCID of the database. + + + :param id: The id of this DatabaseSummary. + :type: str + """ + self._id = id + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this DatabaseSummary. + Additional information about the current lifecycleState. + + + :return: The lifecycle_details of this DatabaseSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this DatabaseSummary. + Additional information about the current lifecycleState. + + + :param lifecycle_details: The lifecycle_details of this DatabaseSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this DatabaseSummary. + The current state of the database. + + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this DatabaseSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this DatabaseSummary. + The current state of the database. + + + :param lifecycle_state: The lifecycle_state of this DatabaseSummary. + :type: str + """ + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def ncharacter_set(self): + """ + Gets the ncharacter_set of this DatabaseSummary. + The national character set for the database. + + + :return: The ncharacter_set of this DatabaseSummary. + :rtype: str + """ + return self._ncharacter_set + + @ncharacter_set.setter + def ncharacter_set(self, ncharacter_set): + """ + Sets the ncharacter_set of this DatabaseSummary. + The national character set for the database. + + + :param ncharacter_set: The ncharacter_set of this DatabaseSummary. + :type: str + """ + self._ncharacter_set = ncharacter_set + + @property + def pdb_name(self): + """ + Gets the pdb_name of this DatabaseSummary. + Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + + + :return: The pdb_name of this DatabaseSummary. + :rtype: str + """ + return self._pdb_name + + @pdb_name.setter + def pdb_name(self, pdb_name): + """ + Sets the pdb_name of this DatabaseSummary. + Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + + + :param pdb_name: The pdb_name of this DatabaseSummary. + :type: str + """ + self._pdb_name = pdb_name + + @property + def time_created(self): + """ + Gets the time_created of this DatabaseSummary. + The date and time the database was created. + + + :return: The time_created of this DatabaseSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this DatabaseSummary. + The date and time the database was created. + + + :param time_created: The time_created of this DatabaseSummary. + :type: datetime + """ + self._time_created = time_created + + 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/database/models/db_home.py b/src/oci/database/models/db_home.py new file mode 100644 index 0000000000..17a2c8cca9 --- /dev/null +++ b/src/oci/database/models/db_home.py @@ -0,0 +1,224 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class DbHome(object): + + def __init__(self): + + self.swagger_types = { + 'compartment_id': 'str', + 'db_system_id': 'str', + 'db_version': 'str', + 'display_name': 'str', + 'id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'db_system_id': 'dbSystemId', + 'db_version': 'dbVersion', + 'display_name': 'displayName', + 'id': 'id', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated' + } + + self._compartment_id = None + self._db_system_id = None + self._db_version = None + self._display_name = None + self._id = None + self._lifecycle_state = None + self._time_created = None + + @property + def compartment_id(self): + """ + Gets the compartment_id of this DbHome. + The OCID of the compartment. + + + :return: The compartment_id of this DbHome. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this DbHome. + The OCID of the compartment. + + + :param compartment_id: The compartment_id of this DbHome. + :type: str + """ + self._compartment_id = compartment_id + + @property + def db_system_id(self): + """ + Gets the db_system_id of this DbHome. + The OCID of the DB System. + + + :return: The db_system_id of this DbHome. + :rtype: str + """ + return self._db_system_id + + @db_system_id.setter + def db_system_id(self, db_system_id): + """ + Sets the db_system_id of this DbHome. + The OCID of the DB System. + + + :param db_system_id: The db_system_id of this DbHome. + :type: str + """ + self._db_system_id = db_system_id + + @property + def db_version(self): + """ + Gets the db_version of this DbHome. + The Oracle database version. + + + :return: The db_version of this DbHome. + :rtype: str + """ + return self._db_version + + @db_version.setter + def db_version(self, db_version): + """ + Sets the db_version of this DbHome. + The Oracle database version. + + + :param db_version: The db_version of this DbHome. + :type: str + """ + self._db_version = db_version + + @property + def display_name(self): + """ + Gets the display_name of this DbHome. + The user-provided name for the database home. It does not need to be unique. + + + :return: The display_name of this DbHome. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this DbHome. + The user-provided name for the database home. It does not need to be unique. + + + :param display_name: The display_name of this DbHome. + :type: str + """ + self._display_name = display_name + + @property + def id(self): + """ + Gets the id of this DbHome. + The OCID of the database home. + + + :return: The id of this DbHome. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this DbHome. + The OCID of the database home. + + + :param id: The id of this DbHome. + :type: str + """ + self._id = id + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this DbHome. + The current state of the database home. + + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this DbHome. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this DbHome. + The current state of the database home. + + + :param lifecycle_state: The lifecycle_state of this DbHome. + :type: str + """ + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def time_created(self): + """ + Gets the time_created of this DbHome. + The date and time the database home was created. + + + :return: The time_created of this DbHome. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this DbHome. + The date and time the database home was created. + + + :param time_created: The time_created of this DbHome. + :type: datetime + """ + self._time_created = time_created + + 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/database/models/db_home_summary.py b/src/oci/database/models/db_home_summary.py new file mode 100644 index 0000000000..83c923acad --- /dev/null +++ b/src/oci/database/models/db_home_summary.py @@ -0,0 +1,224 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class DbHomeSummary(object): + + def __init__(self): + + self.swagger_types = { + 'compartment_id': 'str', + 'db_system_id': 'str', + 'db_version': 'str', + 'display_name': 'str', + 'id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'db_system_id': 'dbSystemId', + 'db_version': 'dbVersion', + 'display_name': 'displayName', + 'id': 'id', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated' + } + + self._compartment_id = None + self._db_system_id = None + self._db_version = None + self._display_name = None + self._id = None + self._lifecycle_state = None + self._time_created = None + + @property + def compartment_id(self): + """ + Gets the compartment_id of this DbHomeSummary. + The OCID of the compartment. + + + :return: The compartment_id of this DbHomeSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this DbHomeSummary. + The OCID of the compartment. + + + :param compartment_id: The compartment_id of this DbHomeSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def db_system_id(self): + """ + Gets the db_system_id of this DbHomeSummary. + The OCID of the DB System. + + + :return: The db_system_id of this DbHomeSummary. + :rtype: str + """ + return self._db_system_id + + @db_system_id.setter + def db_system_id(self, db_system_id): + """ + Sets the db_system_id of this DbHomeSummary. + The OCID of the DB System. + + + :param db_system_id: The db_system_id of this DbHomeSummary. + :type: str + """ + self._db_system_id = db_system_id + + @property + def db_version(self): + """ + Gets the db_version of this DbHomeSummary. + The Oracle database version. + + + :return: The db_version of this DbHomeSummary. + :rtype: str + """ + return self._db_version + + @db_version.setter + def db_version(self, db_version): + """ + Sets the db_version of this DbHomeSummary. + The Oracle database version. + + + :param db_version: The db_version of this DbHomeSummary. + :type: str + """ + self._db_version = db_version + + @property + def display_name(self): + """ + Gets the display_name of this DbHomeSummary. + The user-provided name for the database home. It does not need to be unique. + + + :return: The display_name of this DbHomeSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this DbHomeSummary. + The user-provided name for the database home. It does not need to be unique. + + + :param display_name: The display_name of this DbHomeSummary. + :type: str + """ + self._display_name = display_name + + @property + def id(self): + """ + Gets the id of this DbHomeSummary. + The OCID of the database home. + + + :return: The id of this DbHomeSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this DbHomeSummary. + The OCID of the database home. + + + :param id: The id of this DbHomeSummary. + :type: str + """ + self._id = id + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this DbHomeSummary. + The current state of the database home. + + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this DbHomeSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this DbHomeSummary. + The current state of the database home. + + + :param lifecycle_state: The lifecycle_state of this DbHomeSummary. + :type: str + """ + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def time_created(self): + """ + Gets the time_created of this DbHomeSummary. + The date and time the database home was created. + + + :return: The time_created of this DbHomeSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this DbHomeSummary. + The date and time the database home was created. + + + :param time_created: The time_created of this DbHomeSummary. + :type: datetime + """ + self._time_created = time_created + + 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/database/models/db_node.py b/src/oci/database/models/db_node.py new file mode 100644 index 0000000000..8e0e78a9b7 --- /dev/null +++ b/src/oci/database/models/db_node.py @@ -0,0 +1,224 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class DbNode(object): + + def __init__(self): + + self.swagger_types = { + 'backup_vnic_id': 'str', + 'db_system_id': 'str', + 'hostname': 'str', + 'id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'vnic_id': 'str' + } + + self.attribute_map = { + 'backup_vnic_id': 'backupVnicId', + 'db_system_id': 'dbSystemId', + 'hostname': 'hostname', + 'id': 'id', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'vnic_id': 'vnicId' + } + + self._backup_vnic_id = None + self._db_system_id = None + self._hostname = None + self._id = None + self._lifecycle_state = None + self._time_created = None + self._vnic_id = None + + @property + def backup_vnic_id(self): + """ + Gets the backup_vnic_id of this DbNode. + The OCID of the backup VNIC. + + + :return: The backup_vnic_id of this DbNode. + :rtype: str + """ + return self._backup_vnic_id + + @backup_vnic_id.setter + def backup_vnic_id(self, backup_vnic_id): + """ + Sets the backup_vnic_id of this DbNode. + The OCID of the backup VNIC. + + + :param backup_vnic_id: The backup_vnic_id of this DbNode. + :type: str + """ + self._backup_vnic_id = backup_vnic_id + + @property + def db_system_id(self): + """ + Gets the db_system_id of this DbNode. + The OCID of the DB System. + + + :return: The db_system_id of this DbNode. + :rtype: str + """ + return self._db_system_id + + @db_system_id.setter + def db_system_id(self, db_system_id): + """ + Sets the db_system_id of this DbNode. + The OCID of the DB System. + + + :param db_system_id: The db_system_id of this DbNode. + :type: str + """ + self._db_system_id = db_system_id + + @property + def hostname(self): + """ + Gets the hostname of this DbNode. + The host name for the DB Node. + + + :return: The hostname of this DbNode. + :rtype: str + """ + return self._hostname + + @hostname.setter + def hostname(self, hostname): + """ + Sets the hostname of this DbNode. + The host name for the DB Node. + + + :param hostname: The hostname of this DbNode. + :type: str + """ + self._hostname = hostname + + @property + def id(self): + """ + Gets the id of this DbNode. + The OCID of the DB Node. + + + :return: The id of this DbNode. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this DbNode. + The OCID of the DB Node. + + + :param id: The id of this DbNode. + :type: str + """ + self._id = id + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this DbNode. + The current state of the database node. + + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this DbNode. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this DbNode. + The current state of the database node. + + + :param lifecycle_state: The lifecycle_state of this DbNode. + :type: str + """ + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "FAILED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def time_created(self): + """ + Gets the time_created of this DbNode. + The date and time that the DB Node was created. + + + :return: The time_created of this DbNode. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this DbNode. + The date and time that the DB Node was created. + + + :param time_created: The time_created of this DbNode. + :type: datetime + """ + self._time_created = time_created + + @property + def vnic_id(self): + """ + Gets the vnic_id of this DbNode. + The OCID of the VNIC. + + + :return: The vnic_id of this DbNode. + :rtype: str + """ + return self._vnic_id + + @vnic_id.setter + def vnic_id(self, vnic_id): + """ + Sets the vnic_id of this DbNode. + The OCID of the VNIC. + + + :param vnic_id: The vnic_id of this DbNode. + :type: str + """ + self._vnic_id = vnic_id + + 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/database/models/db_node_summary.py b/src/oci/database/models/db_node_summary.py new file mode 100644 index 0000000000..af9cea7776 --- /dev/null +++ b/src/oci/database/models/db_node_summary.py @@ -0,0 +1,224 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class DbNodeSummary(object): + + def __init__(self): + + self.swagger_types = { + 'backup_vnic_id': 'str', + 'db_system_id': 'str', + 'hostname': 'str', + 'id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'vnic_id': 'str' + } + + self.attribute_map = { + 'backup_vnic_id': 'backupVnicId', + 'db_system_id': 'dbSystemId', + 'hostname': 'hostname', + 'id': 'id', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'vnic_id': 'vnicId' + } + + self._backup_vnic_id = None + self._db_system_id = None + self._hostname = None + self._id = None + self._lifecycle_state = None + self._time_created = None + self._vnic_id = None + + @property + def backup_vnic_id(self): + """ + Gets the backup_vnic_id of this DbNodeSummary. + The OCID of the backup VNIC. + + + :return: The backup_vnic_id of this DbNodeSummary. + :rtype: str + """ + return self._backup_vnic_id + + @backup_vnic_id.setter + def backup_vnic_id(self, backup_vnic_id): + """ + Sets the backup_vnic_id of this DbNodeSummary. + The OCID of the backup VNIC. + + + :param backup_vnic_id: The backup_vnic_id of this DbNodeSummary. + :type: str + """ + self._backup_vnic_id = backup_vnic_id + + @property + def db_system_id(self): + """ + Gets the db_system_id of this DbNodeSummary. + The OCID of the DB System. + + + :return: The db_system_id of this DbNodeSummary. + :rtype: str + """ + return self._db_system_id + + @db_system_id.setter + def db_system_id(self, db_system_id): + """ + Sets the db_system_id of this DbNodeSummary. + The OCID of the DB System. + + + :param db_system_id: The db_system_id of this DbNodeSummary. + :type: str + """ + self._db_system_id = db_system_id + + @property + def hostname(self): + """ + Gets the hostname of this DbNodeSummary. + The host name for the DB Node. + + + :return: The hostname of this DbNodeSummary. + :rtype: str + """ + return self._hostname + + @hostname.setter + def hostname(self, hostname): + """ + Sets the hostname of this DbNodeSummary. + The host name for the DB Node. + + + :param hostname: The hostname of this DbNodeSummary. + :type: str + """ + self._hostname = hostname + + @property + def id(self): + """ + Gets the id of this DbNodeSummary. + The OCID of the DB Node. + + + :return: The id of this DbNodeSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this DbNodeSummary. + The OCID of the DB Node. + + + :param id: The id of this DbNodeSummary. + :type: str + """ + self._id = id + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this DbNodeSummary. + The current state of the database node. + + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this DbNodeSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this DbNodeSummary. + The current state of the database node. + + + :param lifecycle_state: The lifecycle_state of this DbNodeSummary. + :type: str + """ + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "FAILED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def time_created(self): + """ + Gets the time_created of this DbNodeSummary. + The date and time that the DB Node was created. + + + :return: The time_created of this DbNodeSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this DbNodeSummary. + The date and time that the DB Node was created. + + + :param time_created: The time_created of this DbNodeSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def vnic_id(self): + """ + Gets the vnic_id of this DbNodeSummary. + The OCID of the VNIC. + + + :return: The vnic_id of this DbNodeSummary. + :rtype: str + """ + return self._vnic_id + + @vnic_id.setter + def vnic_id(self, vnic_id): + """ + Sets the vnic_id of this DbNodeSummary. + The OCID of the VNIC. + + + :param vnic_id: The vnic_id of this DbNodeSummary. + :type: str + """ + self._vnic_id = vnic_id + + 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/database/models/db_system.py b/src/oci/database/models/db_system.py new file mode 100644 index 0000000000..d39e36f58a --- /dev/null +++ b/src/oci/database/models/db_system.py @@ -0,0 +1,712 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class DbSystem(object): + + def __init__(self): + + self.swagger_types = { + 'availability_domain': 'str', + 'backup_subnet_id': 'str', + 'cluster_name': 'str', + 'compartment_id': 'str', + 'cpu_core_count': 'int', + 'data_storage_percentage': 'int', + 'database_edition': 'str', + 'disk_redundancy': 'str', + 'display_name': 'str', + 'domain': 'str', + 'hostname': 'str', + 'id': 'str', + 'lifecycle_details': 'str', + 'lifecycle_state': 'str', + 'listener_port': 'int', + 'scan_dns_record_id': 'str', + 'scan_ip_ids': 'list[str]', + 'shape': 'str', + 'ssh_public_keys': 'list[str]', + 'subnet_id': 'str', + 'time_created': 'datetime', + 'version': 'str', + 'vip_ids': 'list[str]' + } + + self.attribute_map = { + 'availability_domain': 'availabilityDomain', + 'backup_subnet_id': 'backupSubnetId', + 'cluster_name': 'clusterName', + 'compartment_id': 'compartmentId', + 'cpu_core_count': 'cpuCoreCount', + 'data_storage_percentage': 'dataStoragePercentage', + 'database_edition': 'databaseEdition', + 'disk_redundancy': 'diskRedundancy', + 'display_name': 'displayName', + 'domain': 'domain', + 'hostname': 'hostname', + 'id': 'id', + 'lifecycle_details': 'lifecycleDetails', + 'lifecycle_state': 'lifecycleState', + 'listener_port': 'listenerPort', + 'scan_dns_record_id': 'scanDnsRecordId', + 'scan_ip_ids': 'scanIpIds', + 'shape': 'shape', + 'ssh_public_keys': 'sshPublicKeys', + 'subnet_id': 'subnetId', + 'time_created': 'timeCreated', + 'version': 'version', + 'vip_ids': 'vipIds' + } + + self._availability_domain = None + self._backup_subnet_id = None + self._cluster_name = None + self._compartment_id = None + self._cpu_core_count = None + self._data_storage_percentage = None + self._database_edition = None + self._disk_redundancy = None + self._display_name = None + self._domain = None + self._hostname = None + self._id = None + self._lifecycle_details = None + self._lifecycle_state = None + self._listener_port = None + self._scan_dns_record_id = None + self._scan_ip_ids = None + self._shape = None + self._ssh_public_keys = None + self._subnet_id = None + self._time_created = None + self._version = None + self._vip_ids = None + + @property + def availability_domain(self): + """ + Gets the availability_domain of this DbSystem. + The name of the Availability Domain that the DB System is located in. + + + :return: The availability_domain of this DbSystem. + :rtype: str + """ + return self._availability_domain + + @availability_domain.setter + def availability_domain(self, availability_domain): + """ + Sets the availability_domain of this DbSystem. + The name of the Availability Domain that the DB System is located in. + + + :param availability_domain: The availability_domain of this DbSystem. + :type: str + """ + self._availability_domain = availability_domain + + @property + def backup_subnet_id(self): + """ + Gets the backup_subnet_id of this DbSystem. + The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + + **Subnet Restriction:** See above subnetId's 'Subnet Restriction'. + to malfunction. + + + :return: The backup_subnet_id of this DbSystem. + :rtype: str + """ + return self._backup_subnet_id + + @backup_subnet_id.setter + def backup_subnet_id(self, backup_subnet_id): + """ + Sets the backup_subnet_id of this DbSystem. + The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + + **Subnet Restriction:** See above subnetId's 'Subnet Restriction'. + to malfunction. + + + :param backup_subnet_id: The backup_subnet_id of this DbSystem. + :type: str + """ + self._backup_subnet_id = backup_subnet_id + + @property + def cluster_name(self): + """ + Gets the cluster_name of this DbSystem. + Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + + + :return: The cluster_name of this DbSystem. + :rtype: str + """ + return self._cluster_name + + @cluster_name.setter + def cluster_name(self, cluster_name): + """ + Sets the cluster_name of this DbSystem. + Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + + + :param cluster_name: The cluster_name of this DbSystem. + :type: str + """ + self._cluster_name = cluster_name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this DbSystem. + The OCID of the compartment. + + + :return: The compartment_id of this DbSystem. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this DbSystem. + The OCID of the compartment. + + + :param compartment_id: The compartment_id of this DbSystem. + :type: str + """ + self._compartment_id = compartment_id + + @property + def cpu_core_count(self): + """ + Gets the cpu_core_count of this DbSystem. + The number of CPU cores enabled on the DB System. + + + :return: The cpu_core_count of this DbSystem. + :rtype: int + """ + return self._cpu_core_count + + @cpu_core_count.setter + def cpu_core_count(self, cpu_core_count): + """ + Sets the cpu_core_count of this DbSystem. + The number of CPU cores enabled on the DB System. + + + :param cpu_core_count: The cpu_core_count of this DbSystem. + :type: int + """ + self._cpu_core_count = cpu_core_count + + @property + def data_storage_percentage(self): + """ + Gets the data_storage_percentage of this DbSystem. + The percentage assigned to DATA storage (user data and database files). + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. + + + :return: The data_storage_percentage of this DbSystem. + :rtype: int + """ + return self._data_storage_percentage + + @data_storage_percentage.setter + def data_storage_percentage(self, data_storage_percentage): + """ + Sets the data_storage_percentage of this DbSystem. + The percentage assigned to DATA storage (user data and database files). + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. + + + :param data_storage_percentage: The data_storage_percentage of this DbSystem. + :type: int + """ + self._data_storage_percentage = data_storage_percentage + + @property + def database_edition(self): + """ + Gets the database_edition of this DbSystem. + The Oracle Database Edition that applies to all the databases on the DB System. + + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The database_edition of this DbSystem. + :rtype: str + """ + return self._database_edition + + @database_edition.setter + def database_edition(self, database_edition): + """ + Sets the database_edition of this DbSystem. + The Oracle Database Edition that applies to all the databases on the DB System. + + + :param database_edition: The database_edition of this DbSystem. + :type: str + """ + allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE"] + if database_edition not in allowed_values: + database_edition = 'UNKNOWN_ENUM_VALUE' + self._database_edition = database_edition + + @property + def disk_redundancy(self): + """ + Gets the disk_redundancy of this DbSystem. + The type of redundancy configured for the DB System. + Normal is 2-way redundancy. + High is 3-way redundancy. + + Allowed values for this property are: "HIGH", "NORMAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The disk_redundancy of this DbSystem. + :rtype: str + """ + return self._disk_redundancy + + @disk_redundancy.setter + def disk_redundancy(self, disk_redundancy): + """ + Sets the disk_redundancy of this DbSystem. + The type of redundancy configured for the DB System. + Normal is 2-way redundancy. + High is 3-way redundancy. + + + :param disk_redundancy: The disk_redundancy of this DbSystem. + :type: str + """ + allowed_values = ["HIGH", "NORMAL"] + if disk_redundancy not in allowed_values: + disk_redundancy = 'UNKNOWN_ENUM_VALUE' + self._disk_redundancy = disk_redundancy + + @property + def display_name(self): + """ + Gets the display_name of this DbSystem. + The user-friendly name for the DB System. It does not have to be unique. + + + :return: The display_name of this DbSystem. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this DbSystem. + The user-friendly name for the DB System. It does not have to be unique. + + + :param display_name: The display_name of this DbSystem. + :type: str + """ + self._display_name = display_name + + @property + def domain(self): + """ + Gets the domain of this DbSystem. + The domain name for the DB System. + + + :return: The domain of this DbSystem. + :rtype: str + """ + return self._domain + + @domain.setter + def domain(self, domain): + """ + Sets the domain of this DbSystem. + The domain name for the DB System. + + + :param domain: The domain of this DbSystem. + :type: str + """ + self._domain = domain + + @property + def hostname(self): + """ + Gets the hostname of this DbSystem. + The host name for the DB Node. + + + :return: The hostname of this DbSystem. + :rtype: str + """ + return self._hostname + + @hostname.setter + def hostname(self, hostname): + """ + Sets the hostname of this DbSystem. + The host name for the DB Node. + + + :param hostname: The hostname of this DbSystem. + :type: str + """ + self._hostname = hostname + + @property + def id(self): + """ + Gets the id of this DbSystem. + The OCID of the DB System. + + + :return: The id of this DbSystem. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this DbSystem. + The OCID of the DB System. + + + :param id: The id of this DbSystem. + :type: str + """ + self._id = id + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this DbSystem. + Additional information about the current lifecycleState. + + + :return: The lifecycle_details of this DbSystem. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this DbSystem. + Additional information about the current lifecycleState. + + + :param lifecycle_details: The lifecycle_details of this DbSystem. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this DbSystem. + The current state of the DB System. + + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this DbSystem. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this DbSystem. + The current state of the DB System. + + + :param lifecycle_state: The lifecycle_state of this DbSystem. + :type: str + """ + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def listener_port(self): + """ + Gets the listener_port of this DbSystem. + The port number configured for the listener on the DB System. + + + :return: The listener_port of this DbSystem. + :rtype: int + """ + return self._listener_port + + @listener_port.setter + def listener_port(self, listener_port): + """ + Sets the listener_port of this DbSystem. + The port number configured for the listener on the DB System. + + + :param listener_port: The listener_port of this DbSystem. + :type: int + """ + self._listener_port = listener_port + + @property + def scan_dns_record_id(self): + """ + Gets the scan_dns_record_id of this DbSystem. + The OCID of the DNS record for the SCAN IP addresses that are associated with the DB System. + + + :return: The scan_dns_record_id of this DbSystem. + :rtype: str + """ + return self._scan_dns_record_id + + @scan_dns_record_id.setter + def scan_dns_record_id(self, scan_dns_record_id): + """ + Sets the scan_dns_record_id of this DbSystem. + The OCID of the DNS record for the SCAN IP addresses that are associated with the DB System. + + + :param scan_dns_record_id: The scan_dns_record_id of this DbSystem. + :type: str + """ + self._scan_dns_record_id = scan_dns_record_id + + @property + def scan_ip_ids(self): + """ + Gets the scan_ip_ids of this DbSystem. + The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB System. + SCAN IP addresses are typically used for load balancing and are not assigned to any interface. + Clusterware directs the requests to the appropriate nodes in the cluster. + + - For a single-node DB System, this list is empty. + + + :return: The scan_ip_ids of this DbSystem. + :rtype: list[str] + """ + return self._scan_ip_ids + + @scan_ip_ids.setter + def scan_ip_ids(self, scan_ip_ids): + """ + Sets the scan_ip_ids of this DbSystem. + The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB System. + SCAN IP addresses are typically used for load balancing and are not assigned to any interface. + Clusterware directs the requests to the appropriate nodes in the cluster. + + - For a single-node DB System, this list is empty. + + + :param scan_ip_ids: The scan_ip_ids of this DbSystem. + :type: list[str] + """ + self._scan_ip_ids = scan_ip_ids + + @property + def shape(self): + """ + Gets the shape of this DbSystem. + The shape of the DB System. The shape determines the CPU cores, storage, and memory allocated to the DB System. + + + :return: The shape of this DbSystem. + :rtype: str + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DbSystem. + The shape of the DB System. The shape determines the CPU cores, storage, and memory allocated to the DB System. + + + :param shape: The shape of this DbSystem. + :type: str + """ + self._shape = shape + + @property + def ssh_public_keys(self): + """ + Gets the ssh_public_keys of this DbSystem. + The public key portion of one or more key pairs used for SSH access to the DB System. + + + :return: The ssh_public_keys of this DbSystem. + :rtype: list[str] + """ + return self._ssh_public_keys + + @ssh_public_keys.setter + def ssh_public_keys(self, ssh_public_keys): + """ + Sets the ssh_public_keys of this DbSystem. + The public key portion of one or more key pairs used for SSH access to the DB System. + + + :param ssh_public_keys: The ssh_public_keys of this DbSystem. + :type: list[str] + """ + self._ssh_public_keys = ssh_public_keys + + @property + def subnet_id(self): + """ + Gets the subnet_id of this DbSystem. + The OCID of the subnet the DB System is associated with. + + **Subnet Restrictions:** + - For 1- and 2-node RAC DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 + - For Exadata DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + + + :return: The subnet_id of this DbSystem. + :rtype: str + """ + return self._subnet_id + + @subnet_id.setter + def subnet_id(self, subnet_id): + """ + Sets the subnet_id of this DbSystem. + The OCID of the subnet the DB System is associated with. + + **Subnet Restrictions:** + - For 1- and 2-node RAC DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 + - For Exadata DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + + + :param subnet_id: The subnet_id of this DbSystem. + :type: str + """ + self._subnet_id = subnet_id + + @property + def time_created(self): + """ + Gets the time_created of this DbSystem. + The date and time the DB System was created. + + + :return: The time_created of this DbSystem. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this DbSystem. + The date and time the DB System was created. + + + :param time_created: The time_created of this DbSystem. + :type: datetime + """ + self._time_created = time_created + + @property + def version(self): + """ + Gets the version of this DbSystem. + The version of the DB System. + + + :return: The version of this DbSystem. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this DbSystem. + The version of the DB System. + + + :param version: The version of this DbSystem. + :type: str + """ + self._version = version + + @property + def vip_ids(self): + """ + Gets the vip_ids of this DbSystem. + The OCID of the virtual IP (VIP) addresses associated with the DB System. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB System to + enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + + - For a single-node DB System, this list is empty. + + + :return: The vip_ids of this DbSystem. + :rtype: list[str] + """ + return self._vip_ids + + @vip_ids.setter + def vip_ids(self, vip_ids): + """ + Sets the vip_ids of this DbSystem. + The OCID of the virtual IP (VIP) addresses associated with the DB System. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB System to + enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + + - For a single-node DB System, this list is empty. + + + :param vip_ids: The vip_ids of this DbSystem. + :type: list[str] + """ + self._vip_ids = vip_ids + + 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/database/models/db_system_shape_summary.py b/src/oci/database/models/db_system_shape_summary.py new file mode 100644 index 0000000000..5cf2cb2b17 --- /dev/null +++ b/src/oci/database/models/db_system_shape_summary.py @@ -0,0 +1,110 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class DbSystemShapeSummary(object): + + def __init__(self): + + self.swagger_types = { + 'available_core_count': 'int', + 'name': 'str', + 'shape': 'str' + } + + self.attribute_map = { + 'available_core_count': 'availableCoreCount', + 'name': 'name', + 'shape': 'shape' + } + + self._available_core_count = None + self._name = None + self._shape = None + + @property + def available_core_count(self): + """ + Gets the available_core_count of this DbSystemShapeSummary. + The maximum number of CPU cores that can be enabled on the DB System. + + + :return: The available_core_count of this DbSystemShapeSummary. + :rtype: int + """ + return self._available_core_count + + @available_core_count.setter + def available_core_count(self, available_core_count): + """ + Sets the available_core_count of this DbSystemShapeSummary. + The maximum number of CPU cores that can be enabled on the DB System. + + + :param available_core_count: The available_core_count of this DbSystemShapeSummary. + :type: int + """ + self._available_core_count = available_core_count + + @property + def name(self): + """ + Gets the name of this DbSystemShapeSummary. + The name of the shape used for the DB System. + + + :return: The name of this DbSystemShapeSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DbSystemShapeSummary. + The name of the shape used for the DB System. + + + :param name: The name of this DbSystemShapeSummary. + :type: str + """ + self._name = name + + @property + def shape(self): + """ + Gets the shape of this DbSystemShapeSummary. + Deprecated. Use `name` instead of `shape`. + + + :return: The shape of this DbSystemShapeSummary. + :rtype: str + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DbSystemShapeSummary. + Deprecated. Use `name` instead of `shape`. + + + :param shape: The shape of this DbSystemShapeSummary. + :type: str + """ + self._shape = shape + + 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/database/models/db_system_summary.py b/src/oci/database/models/db_system_summary.py new file mode 100644 index 0000000000..07918b7b2e --- /dev/null +++ b/src/oci/database/models/db_system_summary.py @@ -0,0 +1,712 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class DbSystemSummary(object): + + def __init__(self): + + self.swagger_types = { + 'availability_domain': 'str', + 'backup_subnet_id': 'str', + 'cluster_name': 'str', + 'compartment_id': 'str', + 'cpu_core_count': 'int', + 'data_storage_percentage': 'int', + 'database_edition': 'str', + 'disk_redundancy': 'str', + 'display_name': 'str', + 'domain': 'str', + 'hostname': 'str', + 'id': 'str', + 'lifecycle_details': 'str', + 'lifecycle_state': 'str', + 'listener_port': 'int', + 'scan_dns_record_id': 'str', + 'scan_ip_ids': 'list[str]', + 'shape': 'str', + 'ssh_public_keys': 'list[str]', + 'subnet_id': 'str', + 'time_created': 'datetime', + 'version': 'str', + 'vip_ids': 'list[str]' + } + + self.attribute_map = { + 'availability_domain': 'availabilityDomain', + 'backup_subnet_id': 'backupSubnetId', + 'cluster_name': 'clusterName', + 'compartment_id': 'compartmentId', + 'cpu_core_count': 'cpuCoreCount', + 'data_storage_percentage': 'dataStoragePercentage', + 'database_edition': 'databaseEdition', + 'disk_redundancy': 'diskRedundancy', + 'display_name': 'displayName', + 'domain': 'domain', + 'hostname': 'hostname', + 'id': 'id', + 'lifecycle_details': 'lifecycleDetails', + 'lifecycle_state': 'lifecycleState', + 'listener_port': 'listenerPort', + 'scan_dns_record_id': 'scanDnsRecordId', + 'scan_ip_ids': 'scanIpIds', + 'shape': 'shape', + 'ssh_public_keys': 'sshPublicKeys', + 'subnet_id': 'subnetId', + 'time_created': 'timeCreated', + 'version': 'version', + 'vip_ids': 'vipIds' + } + + self._availability_domain = None + self._backup_subnet_id = None + self._cluster_name = None + self._compartment_id = None + self._cpu_core_count = None + self._data_storage_percentage = None + self._database_edition = None + self._disk_redundancy = None + self._display_name = None + self._domain = None + self._hostname = None + self._id = None + self._lifecycle_details = None + self._lifecycle_state = None + self._listener_port = None + self._scan_dns_record_id = None + self._scan_ip_ids = None + self._shape = None + self._ssh_public_keys = None + self._subnet_id = None + self._time_created = None + self._version = None + self._vip_ids = None + + @property + def availability_domain(self): + """ + Gets the availability_domain of this DbSystemSummary. + The name of the Availability Domain that the DB System is located in. + + + :return: The availability_domain of this DbSystemSummary. + :rtype: str + """ + return self._availability_domain + + @availability_domain.setter + def availability_domain(self, availability_domain): + """ + Sets the availability_domain of this DbSystemSummary. + The name of the Availability Domain that the DB System is located in. + + + :param availability_domain: The availability_domain of this DbSystemSummary. + :type: str + """ + self._availability_domain = availability_domain + + @property + def backup_subnet_id(self): + """ + Gets the backup_subnet_id of this DbSystemSummary. + The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + + **Subnet Restriction:** See above subnetId's 'Subnet Restriction'. + to malfunction. + + + :return: The backup_subnet_id of this DbSystemSummary. + :rtype: str + """ + return self._backup_subnet_id + + @backup_subnet_id.setter + def backup_subnet_id(self, backup_subnet_id): + """ + Sets the backup_subnet_id of this DbSystemSummary. + The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + + **Subnet Restriction:** See above subnetId's 'Subnet Restriction'. + to malfunction. + + + :param backup_subnet_id: The backup_subnet_id of this DbSystemSummary. + :type: str + """ + self._backup_subnet_id = backup_subnet_id + + @property + def cluster_name(self): + """ + Gets the cluster_name of this DbSystemSummary. + Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + + + :return: The cluster_name of this DbSystemSummary. + :rtype: str + """ + return self._cluster_name + + @cluster_name.setter + def cluster_name(self, cluster_name): + """ + Sets the cluster_name of this DbSystemSummary. + Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + + + :param cluster_name: The cluster_name of this DbSystemSummary. + :type: str + """ + self._cluster_name = cluster_name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this DbSystemSummary. + The OCID of the compartment. + + + :return: The compartment_id of this DbSystemSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this DbSystemSummary. + The OCID of the compartment. + + + :param compartment_id: The compartment_id of this DbSystemSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def cpu_core_count(self): + """ + Gets the cpu_core_count of this DbSystemSummary. + The number of CPU cores enabled on the DB System. + + + :return: The cpu_core_count of this DbSystemSummary. + :rtype: int + """ + return self._cpu_core_count + + @cpu_core_count.setter + def cpu_core_count(self, cpu_core_count): + """ + Sets the cpu_core_count of this DbSystemSummary. + The number of CPU cores enabled on the DB System. + + + :param cpu_core_count: The cpu_core_count of this DbSystemSummary. + :type: int + """ + self._cpu_core_count = cpu_core_count + + @property + def data_storage_percentage(self): + """ + Gets the data_storage_percentage of this DbSystemSummary. + The percentage assigned to DATA storage (user data and database files). + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. + + + :return: The data_storage_percentage of this DbSystemSummary. + :rtype: int + """ + return self._data_storage_percentage + + @data_storage_percentage.setter + def data_storage_percentage(self, data_storage_percentage): + """ + Sets the data_storage_percentage of this DbSystemSummary. + The percentage assigned to DATA storage (user data and database files). + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. + + + :param data_storage_percentage: The data_storage_percentage of this DbSystemSummary. + :type: int + """ + self._data_storage_percentage = data_storage_percentage + + @property + def database_edition(self): + """ + Gets the database_edition of this DbSystemSummary. + The Oracle Database Edition that applies to all the databases on the DB System. + + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The database_edition of this DbSystemSummary. + :rtype: str + """ + return self._database_edition + + @database_edition.setter + def database_edition(self, database_edition): + """ + Sets the database_edition of this DbSystemSummary. + The Oracle Database Edition that applies to all the databases on the DB System. + + + :param database_edition: The database_edition of this DbSystemSummary. + :type: str + """ + allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE"] + if database_edition not in allowed_values: + database_edition = 'UNKNOWN_ENUM_VALUE' + self._database_edition = database_edition + + @property + def disk_redundancy(self): + """ + Gets the disk_redundancy of this DbSystemSummary. + The type of redundancy configured for the DB System. + Normal is 2-way redundancy. + High is 3-way redundancy. + + Allowed values for this property are: "HIGH", "NORMAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The disk_redundancy of this DbSystemSummary. + :rtype: str + """ + return self._disk_redundancy + + @disk_redundancy.setter + def disk_redundancy(self, disk_redundancy): + """ + Sets the disk_redundancy of this DbSystemSummary. + The type of redundancy configured for the DB System. + Normal is 2-way redundancy. + High is 3-way redundancy. + + + :param disk_redundancy: The disk_redundancy of this DbSystemSummary. + :type: str + """ + allowed_values = ["HIGH", "NORMAL"] + if disk_redundancy not in allowed_values: + disk_redundancy = 'UNKNOWN_ENUM_VALUE' + self._disk_redundancy = disk_redundancy + + @property + def display_name(self): + """ + Gets the display_name of this DbSystemSummary. + The user-friendly name for the DB System. It does not have to be unique. + + + :return: The display_name of this DbSystemSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this DbSystemSummary. + The user-friendly name for the DB System. It does not have to be unique. + + + :param display_name: The display_name of this DbSystemSummary. + :type: str + """ + self._display_name = display_name + + @property + def domain(self): + """ + Gets the domain of this DbSystemSummary. + The domain name for the DB System. + + + :return: The domain of this DbSystemSummary. + :rtype: str + """ + return self._domain + + @domain.setter + def domain(self, domain): + """ + Sets the domain of this DbSystemSummary. + The domain name for the DB System. + + + :param domain: The domain of this DbSystemSummary. + :type: str + """ + self._domain = domain + + @property + def hostname(self): + """ + Gets the hostname of this DbSystemSummary. + The host name for the DB Node. + + + :return: The hostname of this DbSystemSummary. + :rtype: str + """ + return self._hostname + + @hostname.setter + def hostname(self, hostname): + """ + Sets the hostname of this DbSystemSummary. + The host name for the DB Node. + + + :param hostname: The hostname of this DbSystemSummary. + :type: str + """ + self._hostname = hostname + + @property + def id(self): + """ + Gets the id of this DbSystemSummary. + The OCID of the DB System. + + + :return: The id of this DbSystemSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this DbSystemSummary. + The OCID of the DB System. + + + :param id: The id of this DbSystemSummary. + :type: str + """ + self._id = id + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this DbSystemSummary. + Additional information about the current lifecycleState. + + + :return: The lifecycle_details of this DbSystemSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this DbSystemSummary. + Additional information about the current lifecycleState. + + + :param lifecycle_details: The lifecycle_details of this DbSystemSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this DbSystemSummary. + The current state of the DB System. + + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this DbSystemSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this DbSystemSummary. + The current state of the DB System. + + + :param lifecycle_state: The lifecycle_state of this DbSystemSummary. + :type: str + """ + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def listener_port(self): + """ + Gets the listener_port of this DbSystemSummary. + The port number configured for the listener on the DB System. + + + :return: The listener_port of this DbSystemSummary. + :rtype: int + """ + return self._listener_port + + @listener_port.setter + def listener_port(self, listener_port): + """ + Sets the listener_port of this DbSystemSummary. + The port number configured for the listener on the DB System. + + + :param listener_port: The listener_port of this DbSystemSummary. + :type: int + """ + self._listener_port = listener_port + + @property + def scan_dns_record_id(self): + """ + Gets the scan_dns_record_id of this DbSystemSummary. + The OCID of the DNS record for the SCAN IP addresses that are associated with the DB System. + + + :return: The scan_dns_record_id of this DbSystemSummary. + :rtype: str + """ + return self._scan_dns_record_id + + @scan_dns_record_id.setter + def scan_dns_record_id(self, scan_dns_record_id): + """ + Sets the scan_dns_record_id of this DbSystemSummary. + The OCID of the DNS record for the SCAN IP addresses that are associated with the DB System. + + + :param scan_dns_record_id: The scan_dns_record_id of this DbSystemSummary. + :type: str + """ + self._scan_dns_record_id = scan_dns_record_id + + @property + def scan_ip_ids(self): + """ + Gets the scan_ip_ids of this DbSystemSummary. + The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB System. + SCAN IP addresses are typically used for load balancing and are not assigned to any interface. + Clusterware directs the requests to the appropriate nodes in the cluster. + + - For a single-node DB System, this list is empty. + + + :return: The scan_ip_ids of this DbSystemSummary. + :rtype: list[str] + """ + return self._scan_ip_ids + + @scan_ip_ids.setter + def scan_ip_ids(self, scan_ip_ids): + """ + Sets the scan_ip_ids of this DbSystemSummary. + The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB System. + SCAN IP addresses are typically used for load balancing and are not assigned to any interface. + Clusterware directs the requests to the appropriate nodes in the cluster. + + - For a single-node DB System, this list is empty. + + + :param scan_ip_ids: The scan_ip_ids of this DbSystemSummary. + :type: list[str] + """ + self._scan_ip_ids = scan_ip_ids + + @property + def shape(self): + """ + Gets the shape of this DbSystemSummary. + The shape of the DB System. The shape determines the CPU cores, storage, and memory allocated to the DB System. + + + :return: The shape of this DbSystemSummary. + :rtype: str + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DbSystemSummary. + The shape of the DB System. The shape determines the CPU cores, storage, and memory allocated to the DB System. + + + :param shape: The shape of this DbSystemSummary. + :type: str + """ + self._shape = shape + + @property + def ssh_public_keys(self): + """ + Gets the ssh_public_keys of this DbSystemSummary. + The public key portion of one or more key pairs used for SSH access to the DB System. + + + :return: The ssh_public_keys of this DbSystemSummary. + :rtype: list[str] + """ + return self._ssh_public_keys + + @ssh_public_keys.setter + def ssh_public_keys(self, ssh_public_keys): + """ + Sets the ssh_public_keys of this DbSystemSummary. + The public key portion of one or more key pairs used for SSH access to the DB System. + + + :param ssh_public_keys: The ssh_public_keys of this DbSystemSummary. + :type: list[str] + """ + self._ssh_public_keys = ssh_public_keys + + @property + def subnet_id(self): + """ + Gets the subnet_id of this DbSystemSummary. + The OCID of the subnet the DB System is associated with. + + **Subnet Restrictions:** + - For 1- and 2-node RAC DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 + - For Exadata DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + + + :return: The subnet_id of this DbSystemSummary. + :rtype: str + """ + return self._subnet_id + + @subnet_id.setter + def subnet_id(self, subnet_id): + """ + Sets the subnet_id of this DbSystemSummary. + The OCID of the subnet the DB System is associated with. + + **Subnet Restrictions:** + - For 1- and 2-node RAC DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 + - For Exadata DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + + + :param subnet_id: The subnet_id of this DbSystemSummary. + :type: str + """ + self._subnet_id = subnet_id + + @property + def time_created(self): + """ + Gets the time_created of this DbSystemSummary. + The date and time the DB System was created. + + + :return: The time_created of this DbSystemSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this DbSystemSummary. + The date and time the DB System was created. + + + :param time_created: The time_created of this DbSystemSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def version(self): + """ + Gets the version of this DbSystemSummary. + The version of the DB System. + + + :return: The version of this DbSystemSummary. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this DbSystemSummary. + The version of the DB System. + + + :param version: The version of this DbSystemSummary. + :type: str + """ + self._version = version + + @property + def vip_ids(self): + """ + Gets the vip_ids of this DbSystemSummary. + The OCID of the virtual IP (VIP) addresses associated with the DB System. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB System to + enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + + - For a single-node DB System, this list is empty. + + + :return: The vip_ids of this DbSystemSummary. + :rtype: list[str] + """ + return self._vip_ids + + @vip_ids.setter + def vip_ids(self, vip_ids): + """ + Sets the vip_ids of this DbSystemSummary. + The OCID of the virtual IP (VIP) addresses associated with the DB System. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB System to + enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + + - For a single-node DB System, this list is empty. + + + :param vip_ids: The vip_ids of this DbSystemSummary. + :type: list[str] + """ + self._vip_ids = vip_ids + + 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/database/models/db_version_summary.py b/src/oci/database/models/db_version_summary.py new file mode 100644 index 0000000000..9365d1c483 --- /dev/null +++ b/src/oci/database/models/db_version_summary.py @@ -0,0 +1,83 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class DbVersionSummary(object): + + def __init__(self): + + self.swagger_types = { + 'supports_pdb': 'bool', + 'version': 'str' + } + + self.attribute_map = { + 'supports_pdb': 'supportsPdb', + 'version': 'version' + } + + self._supports_pdb = None + self._version = None + + @property + def supports_pdb(self): + """ + Gets the supports_pdb of this DbVersionSummary. + True if this version of the Oracle database software supports pluggable dbs. + + + :return: The supports_pdb of this DbVersionSummary. + :rtype: bool + """ + return self._supports_pdb + + @supports_pdb.setter + def supports_pdb(self, supports_pdb): + """ + Sets the supports_pdb of this DbVersionSummary. + True if this version of the Oracle database software supports pluggable dbs. + + + :param supports_pdb: The supports_pdb of this DbVersionSummary. + :type: bool + """ + self._supports_pdb = supports_pdb + + @property + def version(self): + """ + Gets the version of this DbVersionSummary. + A valid Oracle database version. + + + :return: The version of this DbVersionSummary. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this DbVersionSummary. + A valid Oracle database version. + + + :param version: The version of this DbVersionSummary. + :type: str + """ + self._version = version + + 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/database/models/launch_db_system_details.py b/src/oci/database/models/launch_db_system_details.py new file mode 100644 index 0000000000..88c55c8a0b --- /dev/null +++ b/src/oci/database/models/launch_db_system_details.py @@ -0,0 +1,506 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class LaunchDbSystemDetails(object): + + def __init__(self): + + self.swagger_types = { + 'availability_domain': 'str', + 'backup_subnet_id': 'str', + 'cluster_name': 'str', + 'compartment_id': 'str', + 'cpu_core_count': 'int', + 'data_storage_percentage': 'int', + 'database_edition': 'str', + 'db_home': 'CreateDbHomeDetails', + 'disk_redundancy': 'str', + 'display_name': 'str', + 'domain': 'str', + 'hostname': 'str', + 'shape': 'str', + 'ssh_public_keys': 'list[str]', + 'subnet_id': 'str' + } + + self.attribute_map = { + 'availability_domain': 'availabilityDomain', + 'backup_subnet_id': 'backupSubnetId', + 'cluster_name': 'clusterName', + 'compartment_id': 'compartmentId', + 'cpu_core_count': 'cpuCoreCount', + 'data_storage_percentage': 'dataStoragePercentage', + 'database_edition': 'databaseEdition', + 'db_home': 'dbHome', + 'disk_redundancy': 'diskRedundancy', + 'display_name': 'displayName', + 'domain': 'domain', + 'hostname': 'hostname', + 'shape': 'shape', + 'ssh_public_keys': 'sshPublicKeys', + 'subnet_id': 'subnetId' + } + + self._availability_domain = None + self._backup_subnet_id = None + self._cluster_name = None + self._compartment_id = None + self._cpu_core_count = None + self._data_storage_percentage = None + self._database_edition = None + self._db_home = None + self._disk_redundancy = None + self._display_name = None + self._domain = None + self._hostname = None + self._shape = None + self._ssh_public_keys = None + self._subnet_id = None + + @property + def availability_domain(self): + """ + Gets the availability_domain of this LaunchDbSystemDetails. + The Availability Domain where the DB System is located. + + + :return: The availability_domain of this LaunchDbSystemDetails. + :rtype: str + """ + return self._availability_domain + + @availability_domain.setter + def availability_domain(self, availability_domain): + """ + Sets the availability_domain of this LaunchDbSystemDetails. + The Availability Domain where the DB System is located. + + + :param availability_domain: The availability_domain of this LaunchDbSystemDetails. + :type: str + """ + self._availability_domain = availability_domain + + @property + def backup_subnet_id(self): + """ + Gets the backup_subnet_id of this LaunchDbSystemDetails. + The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + + **Subnet Restrictions:** See above subnetId's **Subnet Restriction**. + + + :return: The backup_subnet_id of this LaunchDbSystemDetails. + :rtype: str + """ + return self._backup_subnet_id + + @backup_subnet_id.setter + def backup_subnet_id(self, backup_subnet_id): + """ + Sets the backup_subnet_id of this LaunchDbSystemDetails. + The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + + **Subnet Restrictions:** See above subnetId's **Subnet Restriction**. + + + :param backup_subnet_id: The backup_subnet_id of this LaunchDbSystemDetails. + :type: str + """ + self._backup_subnet_id = backup_subnet_id + + @property + def cluster_name(self): + """ + Gets the cluster_name of this LaunchDbSystemDetails. + Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + + + :return: The cluster_name of this LaunchDbSystemDetails. + :rtype: str + """ + return self._cluster_name + + @cluster_name.setter + def cluster_name(self, cluster_name): + """ + Sets the cluster_name of this LaunchDbSystemDetails. + Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + + + :param cluster_name: The cluster_name of this LaunchDbSystemDetails. + :type: str + """ + self._cluster_name = cluster_name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this LaunchDbSystemDetails. + The Oracle Cloud ID (OCID) of the compartment the DB System belongs in. + + + :return: The compartment_id of this LaunchDbSystemDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this LaunchDbSystemDetails. + The Oracle Cloud ID (OCID) of the compartment the DB System belongs in. + + + :param compartment_id: The compartment_id of this LaunchDbSystemDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def cpu_core_count(self): + """ + Gets the cpu_core_count of this LaunchDbSystemDetails. + The number of CPU cores to enable. The valid values depend on the specified shape: + + - BM.DenseIO1.36 and BM.HighIO1.36 - Specify a multiple of 2, from 2 to 36. + - BM.RACLocalStorage1.72 - Specify a multiple of 4, from 4 to 72. + - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. + - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. + - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. + + + :return: The cpu_core_count of this LaunchDbSystemDetails. + :rtype: int + """ + return self._cpu_core_count + + @cpu_core_count.setter + def cpu_core_count(self, cpu_core_count): + """ + Sets the cpu_core_count of this LaunchDbSystemDetails. + The number of CPU cores to enable. The valid values depend on the specified shape: + + - BM.DenseIO1.36 and BM.HighIO1.36 - Specify a multiple of 2, from 2 to 36. + - BM.RACLocalStorage1.72 - Specify a multiple of 4, from 4 to 72. + - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. + - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. + - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. + + + :param cpu_core_count: The cpu_core_count of this LaunchDbSystemDetails. + :type: int + """ + self._cpu_core_count = cpu_core_count + + @property + def data_storage_percentage(self): + """ + Gets the data_storage_percentage of this LaunchDbSystemDetails. + The percentage assigned to DATA storage (user data and database files). + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). + Specify 80 or 40. The default is 80 percent assigned to DATA storage. + + + :return: The data_storage_percentage of this LaunchDbSystemDetails. + :rtype: int + """ + return self._data_storage_percentage + + @data_storage_percentage.setter + def data_storage_percentage(self, data_storage_percentage): + """ + Sets the data_storage_percentage of this LaunchDbSystemDetails. + The percentage assigned to DATA storage (user data and database files). + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). + Specify 80 or 40. The default is 80 percent assigned to DATA storage. + + + :param data_storage_percentage: The data_storage_percentage of this LaunchDbSystemDetails. + :type: int + """ + self._data_storage_percentage = data_storage_percentage + + @property + def database_edition(self): + """ + Gets the database_edition of this LaunchDbSystemDetails. + The Oracle Database Edition that applies to all the databases on the DB System. + + Exadata DB Systems and 2-node RAC DB Systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + + + :return: The database_edition of this LaunchDbSystemDetails. + :rtype: str + """ + return self._database_edition + + @database_edition.setter + def database_edition(self, database_edition): + """ + Sets the database_edition of this LaunchDbSystemDetails. + The Oracle Database Edition that applies to all the databases on the DB System. + + Exadata DB Systems and 2-node RAC DB Systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + + + :param database_edition: The database_edition of this LaunchDbSystemDetails. + :type: str + """ + allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE"] + if database_edition not in allowed_values: + raise ValueError( + "Invalid value for `database_edition`, must be one of {0}" + .format(allowed_values) + ) + self._database_edition = database_edition + + @property + def db_home(self): + """ + Gets the db_home of this LaunchDbSystemDetails. + + :return: The db_home of this LaunchDbSystemDetails. + :rtype: CreateDbHomeDetails + """ + return self._db_home + + @db_home.setter + def db_home(self, db_home): + """ + Sets the db_home of this LaunchDbSystemDetails. + + :param db_home: The db_home of this LaunchDbSystemDetails. + :type: CreateDbHomeDetails + """ + self._db_home = db_home + + @property + def disk_redundancy(self): + """ + Gets the disk_redundancy of this LaunchDbSystemDetails. + The type of redundancy configured for the DB System. + Normal is 2-way redundancy, recommended for test and development systems. + High is 3-way redundancy, recommended for production systems. + + Allowed values for this property are: "HIGH", "NORMAL" + + + :return: The disk_redundancy of this LaunchDbSystemDetails. + :rtype: str + """ + return self._disk_redundancy + + @disk_redundancy.setter + def disk_redundancy(self, disk_redundancy): + """ + Sets the disk_redundancy of this LaunchDbSystemDetails. + The type of redundancy configured for the DB System. + Normal is 2-way redundancy, recommended for test and development systems. + High is 3-way redundancy, recommended for production systems. + + + :param disk_redundancy: The disk_redundancy of this LaunchDbSystemDetails. + :type: str + """ + allowed_values = ["HIGH", "NORMAL"] + if disk_redundancy not in allowed_values: + raise ValueError( + "Invalid value for `disk_redundancy`, must be one of {0}" + .format(allowed_values) + ) + self._disk_redundancy = disk_redundancy + + @property + def display_name(self): + """ + Gets the display_name of this LaunchDbSystemDetails. + The user-friendly name for the DB System. It does not have to be unique. + + + :return: The display_name of this LaunchDbSystemDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this LaunchDbSystemDetails. + The user-friendly name for the DB System. It does not have to be unique. + + + :param display_name: The display_name of this LaunchDbSystemDetails. + :type: str + """ + self._display_name = display_name + + @property + def domain(self): + """ + Gets the domain of this LaunchDbSystemDetails. + A domain name used for the DB System. If the Oracle-provided Internet and VCN + Resolver is enabled for the specified subnet, the domain name for the subnet is used + (don't provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + + + :return: The domain of this LaunchDbSystemDetails. + :rtype: str + """ + return self._domain + + @domain.setter + def domain(self, domain): + """ + Sets the domain of this LaunchDbSystemDetails. + A domain name used for the DB System. If the Oracle-provided Internet and VCN + Resolver is enabled for the specified subnet, the domain name for the subnet is used + (don't provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + + + :param domain: The domain of this LaunchDbSystemDetails. + :type: str + """ + self._domain = domain + + @property + def hostname(self): + """ + Gets the hostname of this LaunchDbSystemDetails. + The host name for the DB System. The host name must begin with an alphabetic character and + can contain a maximum of 30 alphanumeric characters, including hyphens (-). + + The maximum length of the combined hostname and domain is 63 characters. + + **Note:** The hostname must be unique within the subnet. If it is not unique, + the DB System will fail to provision. + + + :return: The hostname of this LaunchDbSystemDetails. + :rtype: str + """ + return self._hostname + + @hostname.setter + def hostname(self, hostname): + """ + Sets the hostname of this LaunchDbSystemDetails. + The host name for the DB System. The host name must begin with an alphabetic character and + can contain a maximum of 30 alphanumeric characters, including hyphens (-). + + The maximum length of the combined hostname and domain is 63 characters. + + **Note:** The hostname must be unique within the subnet. If it is not unique, + the DB System will fail to provision. + + + :param hostname: The hostname of this LaunchDbSystemDetails. + :type: str + """ + self._hostname = hostname + + @property + def shape(self): + """ + Gets the shape of this LaunchDbSystemDetails. + The shape of the DB System. The shape determines the CPU cores, storage, and memory allocated to the DB System. To get a list of shapes, use the :func:`list_db_system_shapes` operation. + + + :return: The shape of this LaunchDbSystemDetails. + :rtype: str + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this LaunchDbSystemDetails. + The shape of the DB System. The shape determines the CPU cores, storage, and memory allocated to the DB System. To get a list of shapes, use the :func:`list_db_system_shapes` operation. + + + :param shape: The shape of this LaunchDbSystemDetails. + :type: str + """ + self._shape = shape + + @property + def ssh_public_keys(self): + """ + Gets the ssh_public_keys of this LaunchDbSystemDetails. + The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. + + + :return: The ssh_public_keys of this LaunchDbSystemDetails. + :rtype: list[str] + """ + return self._ssh_public_keys + + @ssh_public_keys.setter + def ssh_public_keys(self, ssh_public_keys): + """ + Sets the ssh_public_keys of this LaunchDbSystemDetails. + The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. + + + :param ssh_public_keys: The ssh_public_keys of this LaunchDbSystemDetails. + :type: list[str] + """ + self._ssh_public_keys = ssh_public_keys + + @property + def subnet_id(self): + """ + Gets the subnet_id of this LaunchDbSystemDetails. + The OCID of the subnet the DB System is associated with. + + **Subnet Restrictions:** + - For 1- and 2-node RAC DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 + - For Exadata DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + + + :return: The subnet_id of this LaunchDbSystemDetails. + :rtype: str + """ + return self._subnet_id + + @subnet_id.setter + def subnet_id(self, subnet_id): + """ + Sets the subnet_id of this LaunchDbSystemDetails. + The OCID of the subnet the DB System is associated with. + + **Subnet Restrictions:** + - For 1- and 2-node RAC DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 + - For Exadata DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + + + :param subnet_id: The subnet_id of this LaunchDbSystemDetails. + :type: str + """ + self._subnet_id = subnet_id + + 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/database/models/update_db_system_details.py b/src/oci/database/models/update_db_system_details.py new file mode 100644 index 0000000000..3dcf314187 --- /dev/null +++ b/src/oci/database/models/update_db_system_details.py @@ -0,0 +1,83 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class UpdateDbSystemDetails(object): + + def __init__(self): + + self.swagger_types = { + 'cpu_core_count': 'int', + 'ssh_public_keys': 'list[str]' + } + + self.attribute_map = { + 'cpu_core_count': 'cpuCoreCount', + 'ssh_public_keys': 'sshPublicKeys' + } + + self._cpu_core_count = None + self._ssh_public_keys = None + + @property + def cpu_core_count(self): + """ + Gets the cpu_core_count of this UpdateDbSystemDetails. + The number of CPU Cores to be set on the DB System + + + :return: The cpu_core_count of this UpdateDbSystemDetails. + :rtype: int + """ + return self._cpu_core_count + + @cpu_core_count.setter + def cpu_core_count(self, cpu_core_count): + """ + Sets the cpu_core_count of this UpdateDbSystemDetails. + The number of CPU Cores to be set on the DB System + + + :param cpu_core_count: The cpu_core_count of this UpdateDbSystemDetails. + :type: int + """ + self._cpu_core_count = cpu_core_count + + @property + def ssh_public_keys(self): + """ + Gets the ssh_public_keys of this UpdateDbSystemDetails. + The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. + + + :return: The ssh_public_keys of this UpdateDbSystemDetails. + :rtype: list[str] + """ + return self._ssh_public_keys + + @ssh_public_keys.setter + def ssh_public_keys(self, ssh_public_keys): + """ + Sets the ssh_public_keys of this UpdateDbSystemDetails. + The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. + + + :param ssh_public_keys: The ssh_public_keys of this UpdateDbSystemDetails. + :type: list[str] + """ + self._ssh_public_keys = ssh_public_keys + + 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/oraclebmc/exceptions.py b/src/oci/exceptions.py similarity index 100% rename from src/oraclebmc/exceptions.py rename to src/oci/exceptions.py diff --git a/src/oraclebmc/identity/__init__.py b/src/oci/identity/__init__.py similarity index 100% rename from src/oraclebmc/identity/__init__.py rename to src/oci/identity/__init__.py diff --git a/src/oraclebmc/identity/identity_client.py b/src/oci/identity/identity_client.py similarity index 84% rename from src/oraclebmc/identity/identity_client.py rename to src/oci/identity/identity_client.py index 4af1a3602a..9ab5ef41be 100644 --- a/src/oraclebmc/identity/identity_client.py +++ b/src/oci/identity/identity_client.py @@ -45,8 +45,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.UserGroupMembership` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.UserGroupMembership` + :rtype: :class:`~oci.response.Response` """ resource_path = "/userGroupMemberships/" method = "POST" @@ -111,8 +111,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Compartment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Compartment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/compartments/" method = "POST" @@ -140,6 +140,72 @@ def create_compartment(self, create_compartment_details, **kwargs): body=create_compartment_details, response_type="Compartment") + def create_customer_secret_key(self, create_customer_secret_key_details, user_id, **kwargs): + """ + CreateCustomerSecretKey + Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service's Amazon S3 + compatible API. For information, see + `Managing User Credentials`__. + + You must specify a *description* for the secret key (although it can be an empty string). It does not + have to be unique, and you can change it anytime with + :func:`update_customer_secret_key`. + + Every user has permission to create a secret key for *their own user ID*. An administrator in your organization + does not need to write a policy to give users this ability. To compare, administrators who have permission to the + tenancy can use this operation to create a secret key for any user, including themselves. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm + + + :param CreateCustomerSecretKeyDetails create_customer_secret_key_details: (required) + Request object for creating a new secret key. + + :param str user_id: (required) + The OCID of the user. + + :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). + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.CustomerSecretKey` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/users/{userId}/customerSecretKeys/" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "opc_retry_token" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_customer_secret_key got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "userId": user_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "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} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_customer_secret_key_details, + response_type="CustomerSecretKey") + def create_group(self, create_group_details, **kwargs): """ CreateGroup @@ -179,8 +245,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Group` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Group` + :rtype: :class:`~oci.response.Response` """ resource_path = "/groups/" method = "POST" @@ -244,8 +310,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.IdentityProvider` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdentityProvider` + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/" method = "POST" @@ -293,8 +359,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.IdpGroupMapping` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdpGroupMapping` + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/{identityProviderId}/groupMappings/" method = "POST" @@ -356,8 +422,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.UIPassword` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.UIPassword` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}/uiPassword" method = "POST" @@ -426,8 +492,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Policy` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Policy` + :rtype: :class:`~oci.response.Response` """ resource_path = "/policies/" method = "POST" @@ -474,8 +540,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.RegionSubscription` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.RegionSubscription` + :rtype: :class:`~oci.response.Response` """ resource_path = "/tenancies/{tenancyId}/regionSubscriptions" method = "POST" @@ -539,8 +605,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.SwiftPassword` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.SwiftPassword` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}/swiftPasswords/" method = "POST" @@ -628,8 +694,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.User` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.User` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/" method = "POST" @@ -679,8 +745,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}/apiKeys/{fingerprint}" method = "DELETE" @@ -713,6 +779,57 @@ def delete_api_key(self, user_id, fingerprint, **kwargs): path_params=path_params, header_params=header_params) + def delete_customer_secret_key(self, user_id, customer_secret_key_id, **kwargs): + """ + DeleteCustomerSecretKey + Deletes the specified secret key for the specified user. + + + :param str user_id: (required) + The OCID of the user. + + :param str customer_secret_key_id: (required) + The OCID of the secret key. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/users/{userId}/customerSecretKeys/{customerSecretKeyId}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "if_match" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_customer_secret_key got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "userId": user_id, + "customerSecretKeyId": customer_secret_key_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + def delete_group(self, group_id, **kwargs): """ DeleteGroup @@ -727,8 +844,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/groups/{groupId}" method = "DELETE" @@ -775,8 +892,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/{identityProviderId}" method = "DELETE" @@ -825,8 +942,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/{identityProviderId}/groupMappings/{mappingId}" method = "DELETE" @@ -873,8 +990,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/policies/{policyId}" method = "DELETE" @@ -923,8 +1040,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}/swiftPasswords/{swiftPasswordId}" method = "DELETE" @@ -971,8 +1088,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}" method = "DELETE" @@ -1020,8 +1137,8 @@ def get_compartment(self, compartment_id, **kwargs): :param str compartment_id: (required) The OCID of the compartment. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Compartment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Compartment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/compartments/{compartmentId}" method = "GET" @@ -1060,8 +1177,8 @@ def get_group(self, group_id, **kwargs): :param str group_id: (required) The OCID of the group. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Group` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Group` + :rtype: :class:`~oci.response.Response` """ resource_path = "/groups/{groupId}" method = "GET" @@ -1096,8 +1213,8 @@ def get_identity_provider(self, identity_provider_id, **kwargs): :param str identity_provider_id: (required) The OCID of the identity provider. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.IdentityProvider` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdentityProvider` + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/{identityProviderId}" method = "GET" @@ -1135,8 +1252,8 @@ def get_idp_group_mapping(self, identity_provider_id, mapping_id, **kwargs): :param str mapping_id: (required) The OCID of the group mapping. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.IdpGroupMapping` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdpGroupMapping` + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/{identityProviderId}/groupMappings/{mappingId}" method = "GET" @@ -1172,8 +1289,8 @@ def get_policy(self, policy_id, **kwargs): :param str policy_id: (required) The OCID of the policy. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Policy` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Policy` + :rtype: :class:`~oci.response.Response` """ resource_path = "/policies/{policyId}" method = "GET" @@ -1208,8 +1325,8 @@ def get_tenancy(self, tenancy_id, **kwargs): :param str tenancy_id: (required) The OCID of the tenancy. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Tenancy` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Tenancy` + :rtype: :class:`~oci.response.Response` """ resource_path = "/tenancies/{tenancyId}" method = "GET" @@ -1244,8 +1361,8 @@ def get_user(self, user_id, **kwargs): :param str user_id: (required) The OCID of the user. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.User` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.User` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}" method = "GET" @@ -1280,8 +1397,8 @@ def get_user_group_membership(self, user_group_membership_id, **kwargs): :param str user_group_membership_id: (required) The OCID of the userGroupMembership. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.UserGroupMembership` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.UserGroupMembership` + :rtype: :class:`~oci.response.Response` """ resource_path = "/userGroupMemberships/{userGroupMembershipId}" method = "GET" @@ -1319,8 +1436,8 @@ def list_api_keys(self, user_id, **kwargs): :param str user_id: (required) The OCID of the user. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.ApiKey` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.ApiKey` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}/apiKeys/" method = "GET" @@ -1359,8 +1476,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.AvailabilityDomain` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.AvailabilityDomain` + :rtype: :class:`~oci.response.Response` """ resource_path = "/availabilityDomains/" method = "GET" @@ -1405,8 +1522,8 @@ def list_compartments(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.Compartment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.Compartment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/compartments/" method = "GET" @@ -1440,6 +1557,43 @@ def list_compartments(self, compartment_id, **kwargs): header_params=header_params, response_type="list[Compartment]") + def list_customer_secret_keys(self, user_id, **kwargs): + """ + ListCustomerSecretKeys + Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not + the secret key itself. The actual secret key is returned only upon creation. + + + :param str user_id: (required) + The OCID of the user. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.CustomerSecretKeySummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/users/{userId}/customerSecretKeys/" + method = "GET" + + if kwargs: + raise ValueError( + "list_customer_secret_keys got unknown kwargs: {!r}".format(kwargs)) + + path_params = { + "userId": user_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="list[CustomerSecretKeySummary]") + def list_groups(self, compartment_id, **kwargs): """ ListGroups @@ -1459,8 +1613,8 @@ def list_groups(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.Group` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.Group` + :rtype: :class:`~oci.response.Response` """ resource_path = "/groups/" method = "GET" @@ -1517,8 +1671,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.IdentityProvider` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.IdentityProvider` + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/" method = "GET" @@ -1568,8 +1722,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.IdpGroupMapping` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.IdpGroupMapping` + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/{identityProviderId}/groupMappings/" method = "GET" @@ -1629,8 +1783,8 @@ def list_policies(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.Policy` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.Policy` + :rtype: :class:`~oci.response.Response` """ resource_path = "/policies/" method = "GET" @@ -1673,8 +1827,8 @@ def list_region_subscriptions(self, tenancy_id, **kwargs): :param str tenancy_id: (required) The OCID of the tenancy. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.RegionSubscription` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.RegionSubscription` + :rtype: :class:`~oci.response.Response` """ resource_path = "/tenancies/{tenancyId}/regionSubscriptions" method = "GET" @@ -1706,8 +1860,8 @@ def list_regions(self, **kwargs): Lists all the regions offered by Oracle Bare Metal Cloud Services. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.Region` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.Region` + :rtype: :class:`~oci.response.Response` """ resource_path = "/regions" method = "GET" @@ -1737,8 +1891,8 @@ def list_swift_passwords(self, user_id, **kwargs): :param str user_id: (required) The OCID of the user. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.SwiftPassword` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.SwiftPassword` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}/swiftPasswords/" method = "GET" @@ -1795,8 +1949,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.UserGroupMembership` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.UserGroupMembership` + :rtype: :class:`~oci.response.Response` """ resource_path = "/userGroupMemberships/" method = "GET" @@ -1853,8 +2007,8 @@ def list_users(self, compartment_id, **kwargs): :param int limit: (optional) The maximum number of items to return in a paginated \"List\" call. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.identity.models.User` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.User` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/" method = "GET" @@ -1902,8 +2056,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/userGroupMemberships/{userGroupMembershipId}" method = "DELETE" @@ -1952,8 +2106,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Compartment` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Compartment` + :rtype: :class:`~oci.response.Response` """ resource_path = "/compartments/{compartmentId}" method = "PUT" @@ -1987,6 +2141,62 @@ def update_compartment(self, compartment_id, update_compartment_details, **kwarg body=update_compartment_details, response_type="Compartment") + def update_customer_secret_key(self, user_id, customer_secret_key_id, update_customer_secret_key_details, **kwargs): + """ + UpdateCustomerSecretKey + Updates the specified secret key's description. + + + :param str user_id: (required) + The OCID of the user. + + :param str customer_secret_key_id: (required) + The OCID of the secret key. + + :param UpdateCustomerSecretKeyDetails update_customer_secret_key_details: (required) + Request object for updating a secret key. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.CustomerSecretKeySummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/users/{userId}/customerSecretKeys/{customerSecretKeyId}" + method = "PUT" + + # Don't accept unknown kwargs + expected_kwargs = [ + "if_match" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_customer_secret_key got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "userId": user_id, + "customerSecretKeyId": customer_secret_key_id + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_customer_secret_key_details, + response_type="CustomerSecretKeySummary") + def update_group(self, group_id, update_group_details, **kwargs): """ UpdateGroup @@ -2004,8 +2214,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Group` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Group` + :rtype: :class:`~oci.response.Response` """ resource_path = "/groups/{groupId}" method = "PUT" @@ -2056,8 +2266,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.IdentityProvider` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdentityProvider` + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/{identityProviderId}" method = "PUT" @@ -2111,8 +2321,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.IdpGroupMapping` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.IdpGroupMapping` + :rtype: :class:`~oci.response.Response` """ resource_path = "/identityProviders/{identityProviderId}/groupMappings/{mappingId}" method = "PUT" @@ -2166,8 +2376,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.Policy` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.Policy` + :rtype: :class:`~oci.response.Response` """ resource_path = "/policies/{policyId}" method = "PUT" @@ -2221,8 +2431,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.SwiftPassword` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.SwiftPassword` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}/swiftPasswords/{swiftPasswordId}" method = "PUT" @@ -2274,8 +2484,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.User` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.User` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}" method = "PUT" @@ -2326,8 +2536,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.User` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.User` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}/state/" method = "PUT" @@ -2394,8 +2604,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.identity.models.ApiKey` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.ApiKey` + :rtype: :class:`~oci.response.Response` """ resource_path = "/users/{userId}/apiKeys/" method = "POST" diff --git a/src/oraclebmc/identity/models/__init__.py b/src/oci/identity/models/__init__.py similarity index 87% rename from src/oraclebmc/identity/models/__init__.py rename to src/oci/identity/models/__init__.py index da12eff792..982e1c7a8e 100644 --- a/src/oraclebmc/identity/models/__init__.py +++ b/src/oci/identity/models/__init__.py @@ -9,6 +9,7 @@ from .compartment import Compartment from .create_api_key_details import CreateApiKeyDetails from .create_compartment_details import CreateCompartmentDetails +from .create_customer_secret_key_details import CreateCustomerSecretKeyDetails from .create_group_details import CreateGroupDetails from .create_identity_provider_details import CreateIdentityProviderDetails from .create_idp_group_mapping_details import CreateIdpGroupMappingDetails @@ -17,6 +18,8 @@ from .create_saml2_identity_provider_details import CreateSaml2IdentityProviderDetails from .create_swift_password_details import CreateSwiftPasswordDetails from .create_user_details import CreateUserDetails +from .customer_secret_key import CustomerSecretKey +from .customer_secret_key_summary import CustomerSecretKeySummary from .group import Group from .identity_provider import IdentityProvider from .idp_group_mapping import IdpGroupMapping @@ -28,6 +31,7 @@ from .tenancy import Tenancy from .ui_password import UIPassword from .update_compartment_details import UpdateCompartmentDetails +from .update_customer_secret_key_details import UpdateCustomerSecretKeyDetails from .update_group_details import UpdateGroupDetails from .update_identity_provider_details import UpdateIdentityProviderDetails from .update_idp_group_mapping_details import UpdateIdpGroupMappingDetails @@ -47,6 +51,7 @@ "Compartment": Compartment, "CreateApiKeyDetails": CreateApiKeyDetails, "CreateCompartmentDetails": CreateCompartmentDetails, + "CreateCustomerSecretKeyDetails": CreateCustomerSecretKeyDetails, "CreateGroupDetails": CreateGroupDetails, "CreateIdentityProviderDetails": CreateIdentityProviderDetails, "CreateIdpGroupMappingDetails": CreateIdpGroupMappingDetails, @@ -55,6 +60,8 @@ "CreateSaml2IdentityProviderDetails": CreateSaml2IdentityProviderDetails, "CreateSwiftPasswordDetails": CreateSwiftPasswordDetails, "CreateUserDetails": CreateUserDetails, + "CustomerSecretKey": CustomerSecretKey, + "CustomerSecretKeySummary": CustomerSecretKeySummary, "Group": Group, "IdentityProvider": IdentityProvider, "IdpGroupMapping": IdpGroupMapping, @@ -66,6 +73,7 @@ "Tenancy": Tenancy, "UIPassword": UIPassword, "UpdateCompartmentDetails": UpdateCompartmentDetails, + "UpdateCustomerSecretKeyDetails": UpdateCustomerSecretKeyDetails, "UpdateGroupDetails": UpdateGroupDetails, "UpdateIdentityProviderDetails": UpdateIdentityProviderDetails, "UpdateIdpGroupMappingDetails": UpdateIdpGroupMappingDetails, diff --git a/src/oraclebmc/identity/models/add_user_to_group_details.py b/src/oci/identity/models/add_user_to_group_details.py similarity index 100% rename from src/oraclebmc/identity/models/add_user_to_group_details.py rename to src/oci/identity/models/add_user_to_group_details.py diff --git a/src/oraclebmc/identity/models/api_key.py b/src/oci/identity/models/api_key.py similarity index 100% rename from src/oraclebmc/identity/models/api_key.py rename to src/oci/identity/models/api_key.py diff --git a/src/oraclebmc/identity/models/availability_domain.py b/src/oci/identity/models/availability_domain.py similarity index 100% rename from src/oraclebmc/identity/models/availability_domain.py rename to src/oci/identity/models/availability_domain.py diff --git a/src/oraclebmc/identity/models/compartment.py b/src/oci/identity/models/compartment.py similarity index 100% rename from src/oraclebmc/identity/models/compartment.py rename to src/oci/identity/models/compartment.py diff --git a/src/oraclebmc/identity/models/create_api_key_details.py b/src/oci/identity/models/create_api_key_details.py similarity index 100% rename from src/oraclebmc/identity/models/create_api_key_details.py rename to src/oci/identity/models/create_api_key_details.py diff --git a/src/oraclebmc/identity/models/create_compartment_details.py b/src/oci/identity/models/create_compartment_details.py similarity index 97% rename from src/oraclebmc/identity/models/create_compartment_details.py rename to src/oci/identity/models/create_compartment_details.py index 9e552ef894..acafc4f8b8 100644 --- a/src/oraclebmc/identity/models/create_compartment_details.py +++ b/src/oci/identity/models/create_compartment_details.py @@ -54,7 +54,7 @@ def name(self): """ Gets the name of this CreateCompartmentDetails. The name you assign to the compartment during creation. The name must be unique across all compartments - in the tenancy and cannot be changed. + in the tenancy. :return: The name of this CreateCompartmentDetails. @@ -67,7 +67,7 @@ def name(self, name): """ Sets the name of this CreateCompartmentDetails. The name you assign to the compartment during creation. The name must be unique across all compartments - in the tenancy and cannot be changed. + in the tenancy. :param name: The name of this CreateCompartmentDetails. diff --git a/src/oci/identity/models/create_customer_secret_key_details.py b/src/oci/identity/models/create_customer_secret_key_details.py new file mode 100644 index 0000000000..32f14314c9 --- /dev/null +++ b/src/oci/identity/models/create_customer_secret_key_details.py @@ -0,0 +1,56 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class CreateCustomerSecretKeyDetails(object): + + def __init__(self): + + self.swagger_types = { + 'display_name': 'str' + } + + self.attribute_map = { + 'display_name': 'displayName' + } + + self._display_name = None + + @property + def display_name(self): + """ + Gets the display_name of this CreateCustomerSecretKeyDetails. + The name you assign to the secret key during creation. Does not have to be unique, and it's changeable. + + + :return: The display_name of this CreateCustomerSecretKeyDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateCustomerSecretKeyDetails. + The name you assign to the secret key during creation. Does not have to be unique, and it's changeable. + + + :param display_name: The display_name of this CreateCustomerSecretKeyDetails. + :type: str + """ + self._display_name = display_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/oraclebmc/identity/models/create_group_details.py b/src/oci/identity/models/create_group_details.py similarity index 100% rename from src/oraclebmc/identity/models/create_group_details.py rename to src/oci/identity/models/create_group_details.py diff --git a/src/oraclebmc/identity/models/create_identity_provider_details.py b/src/oci/identity/models/create_identity_provider_details.py similarity index 91% rename from src/oraclebmc/identity/models/create_identity_provider_details.py rename to src/oci/identity/models/create_identity_provider_details.py index 00aa7f5d61..1ef612232b 100644 --- a/src/oraclebmc/identity/models/create_identity_provider_details.py +++ b/src/oci/identity/models/create_identity_provider_details.py @@ -126,11 +126,13 @@ def description(self, description): def product_type(self): """ Gets the product_type of this CreateIdentityProviderDetails. - The identity provider service or product (e.g., Oracle Identity Cloud Service). + The identity provider service or product. + Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft + Active Directory Federation Services (ADFS). Example: `IDCS` - Allowed values for this property are: "IDCS" + Allowed values for this property are: "IDCS", "ADFS" :return: The product_type of this CreateIdentityProviderDetails. @@ -142,7 +144,9 @@ def product_type(self): def product_type(self, product_type): """ Sets the product_type of this CreateIdentityProviderDetails. - The identity provider service or product (e.g., Oracle Identity Cloud Service). + The identity provider service or product. + Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft + Active Directory Federation Services (ADFS). Example: `IDCS` @@ -150,7 +154,7 @@ def product_type(self, product_type): :param product_type: The product_type of this CreateIdentityProviderDetails. :type: str """ - allowed_values = ["IDCS"] + allowed_values = ["IDCS", "ADFS"] if product_type not in allowed_values: raise ValueError( "Invalid value for `product_type`, must be one of {0}" diff --git a/src/oraclebmc/identity/models/create_idp_group_mapping_details.py b/src/oci/identity/models/create_idp_group_mapping_details.py similarity index 100% rename from src/oraclebmc/identity/models/create_idp_group_mapping_details.py rename to src/oci/identity/models/create_idp_group_mapping_details.py diff --git a/src/oraclebmc/identity/models/create_policy_details.py b/src/oci/identity/models/create_policy_details.py similarity index 100% rename from src/oraclebmc/identity/models/create_policy_details.py rename to src/oci/identity/models/create_policy_details.py diff --git a/src/oraclebmc/identity/models/create_region_subscription_details.py b/src/oci/identity/models/create_region_subscription_details.py similarity index 97% rename from src/oraclebmc/identity/models/create_region_subscription_details.py rename to src/oci/identity/models/create_region_subscription_details.py index 16fd7ac4f2..f0b1b159ea 100644 --- a/src/oraclebmc/identity/models/create_region_subscription_details.py +++ b/src/oci/identity/models/create_region_subscription_details.py @@ -28,6 +28,7 @@ def region_key(self): Allowed values are: - `PHX` - `IAD` + - `FRA` Example: `PHX` @@ -46,6 +47,7 @@ def region_key(self, region_key): Allowed values are: - `PHX` - `IAD` + - `FRA` Example: `PHX` diff --git a/src/oraclebmc/identity/models/create_saml2_identity_provider_details.py b/src/oci/identity/models/create_saml2_identity_provider_details.py similarity index 100% rename from src/oraclebmc/identity/models/create_saml2_identity_provider_details.py rename to src/oci/identity/models/create_saml2_identity_provider_details.py diff --git a/src/oraclebmc/identity/models/create_swift_password_details.py b/src/oci/identity/models/create_swift_password_details.py similarity index 100% rename from src/oraclebmc/identity/models/create_swift_password_details.py rename to src/oci/identity/models/create_swift_password_details.py diff --git a/src/oraclebmc/identity/models/create_user_details.py b/src/oci/identity/models/create_user_details.py similarity index 100% rename from src/oraclebmc/identity/models/create_user_details.py rename to src/oci/identity/models/create_user_details.py diff --git a/src/oci/identity/models/customer_secret_key.py b/src/oci/identity/models/customer_secret_key.py new file mode 100644 index 0000000000..ad823e7c2b --- /dev/null +++ b/src/oci/identity/models/customer_secret_key.py @@ -0,0 +1,263 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class CustomerSecretKey(object): + + def __init__(self): + + self.swagger_types = { + 'key': 'str', + 'id': 'str', + 'user_id': 'str', + 'display_name': 'str', + 'time_created': 'datetime', + 'time_expires': 'datetime', + 'lifecycle_state': 'str', + 'inactive_status': 'int' + } + + self.attribute_map = { + 'key': 'key', + 'id': 'id', + 'user_id': 'userId', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'time_expires': 'timeExpires', + 'lifecycle_state': 'lifecycleState', + 'inactive_status': 'inactiveStatus' + } + + self._key = None + self._id = None + self._user_id = None + self._display_name = None + self._time_created = None + self._time_expires = None + self._lifecycle_state = None + self._inactive_status = None + + @property + def key(self): + """ + Gets the key of this CustomerSecretKey. + The secret key. + + + :return: The key of this CustomerSecretKey. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this CustomerSecretKey. + The secret key. + + + :param key: The key of this CustomerSecretKey. + :type: str + """ + self._key = key + + @property + def id(self): + """ + Gets the id of this CustomerSecretKey. + The OCID of the secret key. + + + :return: The id of this CustomerSecretKey. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this CustomerSecretKey. + The OCID of the secret key. + + + :param id: The id of this CustomerSecretKey. + :type: str + """ + self._id = id + + @property + def user_id(self): + """ + Gets the user_id of this CustomerSecretKey. + The OCID of the user the password belongs to. + + + :return: The user_id of this CustomerSecretKey. + :rtype: str + """ + return self._user_id + + @user_id.setter + def user_id(self, user_id): + """ + Sets the user_id of this CustomerSecretKey. + The OCID of the user the password belongs to. + + + :param user_id: The user_id of this CustomerSecretKey. + :type: str + """ + self._user_id = user_id + + @property + def display_name(self): + """ + Gets the display_name of this CustomerSecretKey. + The display name you assign to the secret key. Does not have to be unique, and it's changeable. + + + :return: The display_name of this CustomerSecretKey. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CustomerSecretKey. + The display name you assign to the secret key. Does not have to be unique, and it's changeable. + + + :param display_name: The display_name of this CustomerSecretKey. + :type: str + """ + self._display_name = display_name + + @property + def time_created(self): + """ + Gets the time_created of this CustomerSecretKey. + Date and time the `CustomerSecretKey` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + + + :return: The time_created of this CustomerSecretKey. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this CustomerSecretKey. + Date and time the `CustomerSecretKey` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + + + :param time_created: The time_created of this CustomerSecretKey. + :type: datetime + """ + self._time_created = time_created + + @property + def time_expires(self): + """ + Gets the time_expires of this CustomerSecretKey. + Date and time when this password will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + + + :return: The time_expires of this CustomerSecretKey. + :rtype: datetime + """ + return self._time_expires + + @time_expires.setter + def time_expires(self, time_expires): + """ + Sets the time_expires of this CustomerSecretKey. + Date and time when this password will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + + + :param time_expires: The time_expires of this CustomerSecretKey. + :type: datetime + """ + self._time_expires = time_expires + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this CustomerSecretKey. + The secret key's current state. After creating a secret key, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this CustomerSecretKey. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this CustomerSecretKey. + The secret key's current state. After creating a secret key, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + + + :param lifecycle_state: The lifecycle_state of this CustomerSecretKey. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def inactive_status(self): + """ + Gets the inactive_status of this CustomerSecretKey. + The detailed status of INACTIVE lifecycleState. + + + :return: The inactive_status of this CustomerSecretKey. + :rtype: int + """ + return self._inactive_status + + @inactive_status.setter + def inactive_status(self, inactive_status): + """ + Sets the inactive_status of this CustomerSecretKey. + The detailed status of INACTIVE lifecycleState. + + + :param inactive_status: The inactive_status of this CustomerSecretKey. + :type: int + """ + self._inactive_status = inactive_status + + 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/identity/models/customer_secret_key_summary.py b/src/oci/identity/models/customer_secret_key_summary.py new file mode 100644 index 0000000000..6fdb8b8f1e --- /dev/null +++ b/src/oci/identity/models/customer_secret_key_summary.py @@ -0,0 +1,236 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class CustomerSecretKeySummary(object): + + def __init__(self): + + self.swagger_types = { + 'id': 'str', + 'user_id': 'str', + 'display_name': 'str', + 'time_created': 'datetime', + 'time_expires': 'datetime', + 'lifecycle_state': 'str', + 'inactive_status': 'int' + } + + self.attribute_map = { + 'id': 'id', + 'user_id': 'userId', + 'display_name': 'displayName', + 'time_created': 'timeCreated', + 'time_expires': 'timeExpires', + 'lifecycle_state': 'lifecycleState', + 'inactive_status': 'inactiveStatus' + } + + self._id = None + self._user_id = None + self._display_name = None + self._time_created = None + self._time_expires = None + self._lifecycle_state = None + self._inactive_status = None + + @property + def id(self): + """ + Gets the id of this CustomerSecretKeySummary. + The OCID of the secret key. + + + :return: The id of this CustomerSecretKeySummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this CustomerSecretKeySummary. + The OCID of the secret key. + + + :param id: The id of this CustomerSecretKeySummary. + :type: str + """ + self._id = id + + @property + def user_id(self): + """ + Gets the user_id of this CustomerSecretKeySummary. + The OCID of the user the password belongs to. + + + :return: The user_id of this CustomerSecretKeySummary. + :rtype: str + """ + return self._user_id + + @user_id.setter + def user_id(self, user_id): + """ + Sets the user_id of this CustomerSecretKeySummary. + The OCID of the user the password belongs to. + + + :param user_id: The user_id of this CustomerSecretKeySummary. + :type: str + """ + self._user_id = user_id + + @property + def display_name(self): + """ + Gets the display_name of this CustomerSecretKeySummary. + The displayName you assign to the secret key. Does not have to be unique, and it's changeable. + + + :return: The display_name of this CustomerSecretKeySummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CustomerSecretKeySummary. + The displayName you assign to the secret key. Does not have to be unique, and it's changeable. + + + :param display_name: The display_name of this CustomerSecretKeySummary. + :type: str + """ + self._display_name = display_name + + @property + def time_created(self): + """ + Gets the time_created of this CustomerSecretKeySummary. + Date and time the `CustomerSecretKey` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + + + :return: The time_created of this CustomerSecretKeySummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this CustomerSecretKeySummary. + Date and time the `CustomerSecretKey` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + + + :param time_created: The time_created of this CustomerSecretKeySummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_expires(self): + """ + Gets the time_expires of this CustomerSecretKeySummary. + Date and time when this password will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + + + :return: The time_expires of this CustomerSecretKeySummary. + :rtype: datetime + """ + return self._time_expires + + @time_expires.setter + def time_expires(self, time_expires): + """ + Sets the time_expires of this CustomerSecretKeySummary. + Date and time when this password will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + + + :param time_expires: The time_expires of this CustomerSecretKeySummary. + :type: datetime + """ + self._time_expires = time_expires + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this CustomerSecretKeySummary. + The secret key's current state. After creating a secret key, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this CustomerSecretKeySummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this CustomerSecretKeySummary. + The secret key's current state. After creating a secret key, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + + + :param lifecycle_state: The lifecycle_state of this CustomerSecretKeySummary. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED"] + if lifecycle_state not in allowed_values: + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def inactive_status(self): + """ + Gets the inactive_status of this CustomerSecretKeySummary. + The detailed status of INACTIVE lifecycleState. + + + :return: The inactive_status of this CustomerSecretKeySummary. + :rtype: int + """ + return self._inactive_status + + @inactive_status.setter + def inactive_status(self, inactive_status): + """ + Sets the inactive_status of this CustomerSecretKeySummary. + The detailed status of INACTIVE lifecycleState. + + + :param inactive_status: The inactive_status of this CustomerSecretKeySummary. + :type: int + """ + self._inactive_status = inactive_status + + 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/oraclebmc/identity/models/group.py b/src/oci/identity/models/group.py similarity index 100% rename from src/oraclebmc/identity/models/group.py rename to src/oci/identity/models/group.py diff --git a/src/oraclebmc/identity/models/identity_provider.py b/src/oci/identity/models/identity_provider.py similarity index 94% rename from src/oraclebmc/identity/models/identity_provider.py rename to src/oci/identity/models/identity_provider.py index 500e04732d..a8c34ace82 100644 --- a/src/oraclebmc/identity/models/identity_provider.py +++ b/src/oci/identity/models/identity_provider.py @@ -166,8 +166,13 @@ def description(self, description): def product_type(self): """ Gets the product_type of this IdentityProvider. - The identity provider service or product (e.g., Oracle Identity Cloud Service). - Allowed value: `IDCS`. + The identity provider service or product. + Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft + Active Directory Federation Services (ADFS). + + Allowed values are: + - `ADFS` + - `IDCS` Example: `IDCS` @@ -181,8 +186,13 @@ def product_type(self): def product_type(self, product_type): """ Sets the product_type of this IdentityProvider. - The identity provider service or product (e.g., Oracle Identity Cloud Service). - Allowed value: `IDCS`. + The identity provider service or product. + Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft + Active Directory Federation Services (ADFS). + + Allowed values are: + - `ADFS` + - `IDCS` Example: `IDCS` diff --git a/src/oraclebmc/identity/models/idp_group_mapping.py b/src/oci/identity/models/idp_group_mapping.py similarity index 100% rename from src/oraclebmc/identity/models/idp_group_mapping.py rename to src/oci/identity/models/idp_group_mapping.py diff --git a/src/oraclebmc/identity/models/policy.py b/src/oci/identity/models/policy.py similarity index 100% rename from src/oraclebmc/identity/models/policy.py rename to src/oci/identity/models/policy.py diff --git a/src/oraclebmc/identity/models/region.py b/src/oci/identity/models/region.py similarity index 95% rename from src/oraclebmc/identity/models/region.py rename to src/oci/identity/models/region.py index d796417d6d..5fe632dbd4 100644 --- a/src/oraclebmc/identity/models/region.py +++ b/src/oci/identity/models/region.py @@ -31,6 +31,7 @@ def key(self): Allowed values are: - `PHX` - `IAD` + - 'FRA' :return: The key of this Region. @@ -47,6 +48,7 @@ def key(self, key): Allowed values are: - `PHX` - `IAD` + - 'FRA' :param key: The key of this Region. @@ -63,6 +65,7 @@ def name(self): Allowed values are: - `us-phoenix-1` - `us-ashburn-1` + - 'de-frankfurt-1' :return: The name of this Region. @@ -79,6 +82,7 @@ def name(self, name): Allowed values are: - `us-phoenix-1` - `us-ashburn-1` + - 'de-frankfurt-1' :param name: The name of this Region. diff --git a/src/oraclebmc/identity/models/region_subscription.py b/src/oci/identity/models/region_subscription.py similarity index 97% rename from src/oraclebmc/identity/models/region_subscription.py rename to src/oci/identity/models/region_subscription.py index d9461e7a3f..a5d8f27e48 100644 --- a/src/oraclebmc/identity/models/region_subscription.py +++ b/src/oci/identity/models/region_subscription.py @@ -37,6 +37,7 @@ def region_key(self): Allowed values are: - `PHX` - `IAD` + - 'FRA' :return: The region_key of this RegionSubscription. @@ -53,6 +54,7 @@ def region_key(self, region_key): Allowed values are: - `PHX` - `IAD` + - 'FRA' :param region_key: The region_key of this RegionSubscription. @@ -69,6 +71,7 @@ def region_name(self): Allowed values are: - `us-phoenix-1` - `us-ashburn-1` + - 'de-frankfurt-1' :return: The region_name of this RegionSubscription. @@ -85,6 +88,7 @@ def region_name(self, region_name): Allowed values are: - `us-phoenix-1` - `us-ashburn-1` + - 'de-frankfurt-1' :param region_name: The region_name of this RegionSubscription. diff --git a/src/oraclebmc/identity/models/saml2_identity_provider.py b/src/oci/identity/models/saml2_identity_provider.py similarity index 100% rename from src/oraclebmc/identity/models/saml2_identity_provider.py rename to src/oci/identity/models/saml2_identity_provider.py diff --git a/src/oraclebmc/identity/models/swift_password.py b/src/oci/identity/models/swift_password.py similarity index 100% rename from src/oraclebmc/identity/models/swift_password.py rename to src/oci/identity/models/swift_password.py diff --git a/src/oraclebmc/identity/models/tenancy.py b/src/oci/identity/models/tenancy.py similarity index 98% rename from src/oraclebmc/identity/models/tenancy.py rename to src/oci/identity/models/tenancy.py index 09e1aaec5d..4e4925aae2 100644 --- a/src/oraclebmc/identity/models/tenancy.py +++ b/src/oci/identity/models/tenancy.py @@ -109,6 +109,7 @@ def home_region_key(self): Allowed values are: - `IAD` - `PHX` + - `FRA` :return: The home_region_key of this Tenancy. @@ -125,6 +126,7 @@ def home_region_key(self, home_region_key): Allowed values are: - `IAD` - `PHX` + - `FRA` :param home_region_key: The home_region_key of this Tenancy. diff --git a/src/oraclebmc/identity/models/ui_password.py b/src/oci/identity/models/ui_password.py similarity index 100% rename from src/oraclebmc/identity/models/ui_password.py rename to src/oci/identity/models/ui_password.py diff --git a/src/oraclebmc/identity/models/update_compartment_details.py b/src/oci/identity/models/update_compartment_details.py similarity index 61% rename from src/oraclebmc/identity/models/update_compartment_details.py rename to src/oci/identity/models/update_compartment_details.py index 77612c0e7a..c25bc51478 100644 --- a/src/oraclebmc/identity/models/update_compartment_details.py +++ b/src/oci/identity/models/update_compartment_details.py @@ -10,14 +10,17 @@ class UpdateCompartmentDetails(object): def __init__(self): self.swagger_types = { - 'description': 'str' + 'description': 'str', + 'name': 'str' } self.attribute_map = { - 'description': 'description' + 'description': 'description', + 'name': 'name' } self._description = None + self._name = None @property def description(self): @@ -43,6 +46,30 @@ def description(self, description): """ self._description = description + @property + def name(self): + """ + Gets the name of this UpdateCompartmentDetails. + The new name you assign to the compartment. The name must be unique across all compartments in the tenancy. + + + :return: The name of this UpdateCompartmentDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UpdateCompartmentDetails. + The new name you assign to the compartment. The name must be unique across all compartments in the tenancy. + + + :param name: The name of this UpdateCompartmentDetails. + :type: str + """ + self._name = name + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/identity/models/update_customer_secret_key_details.py b/src/oci/identity/models/update_customer_secret_key_details.py new file mode 100644 index 0000000000..6f09d9b298 --- /dev/null +++ b/src/oci/identity/models/update_customer_secret_key_details.py @@ -0,0 +1,56 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class UpdateCustomerSecretKeyDetails(object): + + def __init__(self): + + self.swagger_types = { + 'display_name': 'str' + } + + self.attribute_map = { + 'display_name': 'displayName' + } + + self._display_name = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateCustomerSecretKeyDetails. + The description you assign to the secret key. Does not have to be unique, and it's changeable. + + + :return: The display_name of this UpdateCustomerSecretKeyDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateCustomerSecretKeyDetails. + The description you assign to the secret key. Does not have to be unique, and it's changeable. + + + :param display_name: The display_name of this UpdateCustomerSecretKeyDetails. + :type: str + """ + self._display_name = display_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/oraclebmc/identity/models/update_group_details.py b/src/oci/identity/models/update_group_details.py similarity index 100% rename from src/oraclebmc/identity/models/update_group_details.py rename to src/oci/identity/models/update_group_details.py diff --git a/src/oraclebmc/identity/models/update_identity_provider_details.py b/src/oci/identity/models/update_identity_provider_details.py similarity index 100% rename from src/oraclebmc/identity/models/update_identity_provider_details.py rename to src/oci/identity/models/update_identity_provider_details.py diff --git a/src/oraclebmc/identity/models/update_idp_group_mapping_details.py b/src/oci/identity/models/update_idp_group_mapping_details.py similarity index 100% rename from src/oraclebmc/identity/models/update_idp_group_mapping_details.py rename to src/oci/identity/models/update_idp_group_mapping_details.py diff --git a/src/oraclebmc/identity/models/update_policy_details.py b/src/oci/identity/models/update_policy_details.py similarity index 100% rename from src/oraclebmc/identity/models/update_policy_details.py rename to src/oci/identity/models/update_policy_details.py diff --git a/src/oraclebmc/identity/models/update_saml2_identity_provider_details.py b/src/oci/identity/models/update_saml2_identity_provider_details.py similarity index 100% rename from src/oraclebmc/identity/models/update_saml2_identity_provider_details.py rename to src/oci/identity/models/update_saml2_identity_provider_details.py diff --git a/src/oraclebmc/identity/models/update_state_details.py b/src/oci/identity/models/update_state_details.py similarity index 100% rename from src/oraclebmc/identity/models/update_state_details.py rename to src/oci/identity/models/update_state_details.py diff --git a/src/oraclebmc/identity/models/update_swift_password_details.py b/src/oci/identity/models/update_swift_password_details.py similarity index 100% rename from src/oraclebmc/identity/models/update_swift_password_details.py rename to src/oci/identity/models/update_swift_password_details.py diff --git a/src/oraclebmc/identity/models/update_user_details.py b/src/oci/identity/models/update_user_details.py similarity index 100% rename from src/oraclebmc/identity/models/update_user_details.py rename to src/oci/identity/models/update_user_details.py diff --git a/src/oraclebmc/identity/models/user.py b/src/oci/identity/models/user.py similarity index 100% rename from src/oraclebmc/identity/models/user.py rename to src/oci/identity/models/user.py diff --git a/src/oraclebmc/identity/models/user_group_membership.py b/src/oci/identity/models/user_group_membership.py similarity index 100% rename from src/oraclebmc/identity/models/user_group_membership.py rename to src/oci/identity/models/user_group_membership.py diff --git a/src/oraclebmc/load_balancer/__init__.py b/src/oci/load_balancer/__init__.py similarity index 100% rename from src/oraclebmc/load_balancer/__init__.py rename to src/oci/load_balancer/__init__.py diff --git a/src/oraclebmc/load_balancer/load_balancer_client.py b/src/oci/load_balancer/load_balancer_client.py similarity index 81% rename from src/oraclebmc/load_balancer/load_balancer_client.py rename to src/oci/load_balancer/load_balancer_client.py index d23c7f5e31..a8ce6b7760 100644 --- a/src/oraclebmc/load_balancer/load_balancer_client.py +++ b/src/oci/load_balancer/load_balancer_client.py @@ -43,7 +43,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: `My_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -56,8 +56,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends" method = "POST" @@ -118,8 +118,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets" method = "POST" @@ -179,8 +179,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/certificates" method = "POST" @@ -240,8 +240,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/listeners" method = "POST" @@ -327,8 +327,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers" method = "POST" @@ -371,19 +371,19 @@ 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: `My_backend_set` :param str backend_name: (required) - The name of the backend server to remove. + The IP address and port of the backend server to remove. - Example: `My backend server` + Example: `1.1.1.7:42` :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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}" method = "DELETE" @@ -433,14 +433,14 @@ 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: `My_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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}" method = "DELETE" @@ -487,14 +487,14 @@ def delete_certificate(self, load_balancer_id, certificate_name, **kwargs): :param str certificate_name: (required) The name of the certificate to delete. - Example: `My certificate` + Example: `My_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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/certificates/{certificateName}" method = "DELETE" @@ -547,8 +547,8 @@ def delete_listener(self, load_balancer_id, listener_name, **kwargs): The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/listeners/{listenerName}" method = "DELETE" @@ -596,8 +596,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}" method = "DELETE" @@ -643,19 +643,19 @@ 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: `My_backend_set` :param str backend_name: (required) - The name of the backend server to retrieve. + The IP address and port of the backend server to retrieve. - Example: `My backend server` + Example: `1.1.1.7:42` :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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.load_balancer.models.Backend` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.Backend` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}" method = "GET" @@ -690,6 +690,67 @@ def get_backend(self, load_balancer_id, backend_set_name, backend_name, **kwargs header_params=header_params, response_type="Backend") + def get_backend_health(self, load_balancer_id, backend_set_name, backend_name, **kwargs): + """ + BackendHealth + Gets the current health status of the specified backend server. + + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer associated with the backend server health status to be retrieved. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :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` + + :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` + + :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. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.BackendHealth` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}/health" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "opc_request_id" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_backend_health got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "loadBalancerId": load_balancer_id, + "backendSetName": backend_set_name, + "backendName": backend_name + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + 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} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="BackendHealth") + def get_backend_set(self, load_balancer_id, backend_set_name, **kwargs): """ GetBackendSet @@ -704,14 +765,14 @@ 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: `My_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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.load_balancer.models.BackendSet` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.BackendSet` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}" method = "GET" @@ -745,6 +806,61 @@ def get_backend_set(self, load_balancer_id, backend_set_name, **kwargs): header_params=header_params, response_type="BackendSet") + def get_backend_set_health(self, load_balancer_id, backend_set_name, **kwargs): + """ + BackendSetHealth + Gets the health status for the specified backend set. + + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer associated with the backend set health status to be retrieved. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + :param str backend_set_name: (required) + The name of the backend set to retrieve the health status for. + + Example: `My_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. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.BackendSetHealth` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/health" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "opc_request_id" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_backend_set_health got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "loadBalancerId": load_balancer_id, + "backendSetName": backend_set_name + } + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + 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} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="BackendSetHealth") + def get_health_checker(self, load_balancer_id, backend_set_name, **kwargs): """ GetHealthChecker @@ -757,16 +873,16 @@ def get_health_checker(self, load_balancer_id, backend_set_name, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str backend_set_name: (required) - The name of the backend associated with the health check policy to be retrieved. + The name of the backend set associated with the health check policy to be retrieved. - Example: `My backend set` + Example: `My_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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.load_balancer.models.HealthChecker` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.HealthChecker` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/healthChecker" method = "GET" @@ -815,8 +931,8 @@ def get_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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.load_balancer.models.LoadBalancer` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.LoadBalancer` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}" method = "GET" @@ -849,6 +965,55 @@ def get_load_balancer(self, load_balancer_id, **kwargs): header_params=header_params, response_type="LoadBalancer") + def get_load_balancer_health(self, load_balancer_id, **kwargs): + """ + LoadBalancerHealth + Gets the health status for the specified load balancer. + + + :param str load_balancer_id: (required) + The `OCID`__ of the load balancer to return health status for. + + __ 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. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.LoadBalancerHealth` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/loadBalancers/{loadBalancerId}/health" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "opc_request_id" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_load_balancer_health 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} + + 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} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="LoadBalancerHealth") + def get_work_request(self, work_request_id, **kwargs): """ GetWorkRequest @@ -864,8 +1029,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.load_balancer.models.WorkRequest` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.load_balancer.models.WorkRequest` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancerWorkRequests/{workRequestId}" method = "GET" @@ -913,8 +1078,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.load_balancer.models.BackendSet` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.BackendSet` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets" method = "GET" @@ -961,14 +1126,14 @@ 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: `My_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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.load_balancer.models.Backend` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.Backend` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends" method = "GET" @@ -1017,8 +1182,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.load_balancer.models.Certificate` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.Certificate` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/certificates" method = "GET" @@ -1051,6 +1216,69 @@ def list_certificates(self, load_balancer_id, **kwargs): header_params=header_params, response_type="list[Certificate]") + def list_load_balancer_healths(self, compartment_id, **kwargs): + """ + ListLoadBalancerHealths + Lists the summary health statuses for all load balancers in the specified compartment. + + + :param str compartment_id: (required) + The `OCID`__ of the compartment containing the load balancers to return health status information for. + + __ 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 int limit: (optional) + The maximum number of items to return in a paginated \"List\" call. + + Example: `500` + + :param str page: (optional) + The value of the `opc-next-page` response header from the previous \"List\" call. + + Example: `3` + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancerHealthSummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/loadBalancerHealths" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "opc_request_id", + "limit", + "page" + ] + extra_kwargs = [key for key in six.iterkeys(kwargs) if key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_load_balancer_healths got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "compartmentId": compartment_id + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing} + + 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} + + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[LoadBalancerHealthSummary]") + def list_load_balancers(self, compartment_id, **kwargs): """ ListLoadBalancers @@ -1081,8 +1309,8 @@ def list_load_balancers(self, compartment_id, **kwargs): Example: `full` - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.load_balancer.models.LoadBalancer` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancer` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers" method = "GET" @@ -1146,8 +1374,8 @@ def list_policies(self, compartment_id, **kwargs): Example: `3` - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.load_balancer.models.LoadBalancerPolicy` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancerPolicy` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancerPolicies" method = "GET" @@ -1209,8 +1437,8 @@ def list_protocols(self, compartment_id, **kwargs): Example: `3` - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.load_balancer.models.LoadBalancerProtocol` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancerProtocol` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancerProtocols" method = "GET" @@ -1272,8 +1500,8 @@ def list_shapes(self, compartment_id, **kwargs): Example: `3` - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.load_balancer.models.LoadBalancerShape` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.LoadBalancerShape` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancerShapes" method = "GET" @@ -1335,8 +1563,8 @@ def list_work_requests(self, load_balancer_id, **kwargs): Example: `3` - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.load_balancer.models.WorkRequest` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.load_balancer.models.WorkRequest` + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/workRequests" method = "GET" @@ -1395,12 +1623,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: `My_backend_set` :param str backend_name: (required) - The name of the backend server to update. + The IP address and port of the backend server to update. - Example: `My backend server` + Example: `1.1.1.7:42` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -1413,8 +1641,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}" method = "PUT" @@ -1468,7 +1696,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: `My_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -1481,8 +1709,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}" method = "PUT" @@ -1535,7 +1763,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: `My_backend_set` :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -1548,8 +1776,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/healthChecker" method = "PUT" @@ -1615,8 +1843,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}/listeners/{listenerName}" method = "PUT" @@ -1677,8 +1905,8 @@ 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). - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/loadBalancers/{loadBalancerId}" method = "PUT" diff --git a/src/oraclebmc/load_balancer/models/__init__.py b/src/oci/load_balancer/models/__init__.py similarity index 86% rename from src/oraclebmc/load_balancer/models/__init__.py rename to src/oci/load_balancer/models/__init__.py index 55a9e75939..c63c89a677 100644 --- a/src/oraclebmc/load_balancer/models/__init__.py +++ b/src/oci/load_balancer/models/__init__.py @@ -5,8 +5,10 @@ from .backend import Backend from .backend_details import BackendDetails +from .backend_health import BackendHealth from .backend_set import BackendSet from .backend_set_details import BackendSetDetails +from .backend_set_health import BackendSetHealth from .certificate import Certificate from .certificate_details import CertificateDetails from .create_backend_details import CreateBackendDetails @@ -14,12 +16,15 @@ from .create_certificate_details import CreateCertificateDetails from .create_listener_details import CreateListenerDetails from .create_load_balancer_details import CreateLoadBalancerDetails +from .health_check_result import HealthCheckResult from .health_checker import HealthChecker from .health_checker_details import HealthCheckerDetails from .ip_address import IpAddress from .listener import Listener from .listener_details import ListenerDetails from .load_balancer import LoadBalancer +from .load_balancer_health import LoadBalancerHealth +from .load_balancer_health_summary import LoadBalancerHealthSummary from .load_balancer_policy import LoadBalancerPolicy from .load_balancer_protocol import LoadBalancerProtocol from .load_balancer_shape import LoadBalancerShape @@ -38,8 +43,10 @@ load_balancer_type_mapping = { "Backend": Backend, "BackendDetails": BackendDetails, + "BackendHealth": BackendHealth, "BackendSet": BackendSet, "BackendSetDetails": BackendSetDetails, + "BackendSetHealth": BackendSetHealth, "Certificate": Certificate, "CertificateDetails": CertificateDetails, "CreateBackendDetails": CreateBackendDetails, @@ -47,12 +54,15 @@ "CreateCertificateDetails": CreateCertificateDetails, "CreateListenerDetails": CreateListenerDetails, "CreateLoadBalancerDetails": CreateLoadBalancerDetails, + "HealthCheckResult": HealthCheckResult, "HealthChecker": HealthChecker, "HealthCheckerDetails": HealthCheckerDetails, "IpAddress": IpAddress, "Listener": Listener, "ListenerDetails": ListenerDetails, "LoadBalancer": LoadBalancer, + "LoadBalancerHealth": LoadBalancerHealth, + "LoadBalancerHealthSummary": LoadBalancerHealthSummary, "LoadBalancerPolicy": LoadBalancerPolicy, "LoadBalancerProtocol": LoadBalancerProtocol, "LoadBalancerShape": LoadBalancerShape, diff --git a/src/oraclebmc/load_balancer/models/backend.py b/src/oci/load_balancer/models/backend.py similarity index 95% rename from src/oraclebmc/load_balancer/models/backend.py rename to src/oci/load_balancer/models/backend.py index cb214b9f76..8aaeb2d9af 100644 --- a/src/oraclebmc/load_balancer/models/backend.py +++ b/src/oci/load_balancer/models/backend.py @@ -129,9 +129,9 @@ def ip_address(self, ip_address): def name(self): """ Gets the name of this Backend. - A name to uniquely identify this backend server in the backend set. + A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. - Example: `My first backend server` + Example: `10.10.10.4:8080` :return: The name of this Backend. @@ -143,9 +143,9 @@ def name(self): def name(self, name): """ Sets the name of this Backend. - A name to uniquely identify this backend server in the backend set. + A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. - Example: `My first backend server` + Example: `10.10.10.4:8080` :param name: The name of this Backend. diff --git a/src/oraclebmc/load_balancer/models/backend_details.py b/src/oci/load_balancer/models/backend_details.py similarity index 100% rename from src/oraclebmc/load_balancer/models/backend_details.py rename to src/oci/load_balancer/models/backend_details.py diff --git a/src/oci/load_balancer/models/backend_health.py b/src/oci/load_balancer/models/backend_health.py new file mode 100644 index 0000000000..32c889a64c --- /dev/null +++ b/src/oci/load_balancer/models/backend_health.py @@ -0,0 +1,105 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class BackendHealth(object): + + def __init__(self): + + self.swagger_types = { + 'health_check_results': 'list[HealthCheckResult]', + 'status': 'str' + } + + self.attribute_map = { + 'health_check_results': 'healthCheckResults', + 'status': 'status' + } + + self._health_check_results = None + self._status = None + + @property + def health_check_results(self): + """ + Gets the health_check_results of this BackendHealth. + A list of the most recent health check results returned for the specified backend server. + + + :return: The health_check_results of this BackendHealth. + :rtype: list[HealthCheckResult] + """ + return self._health_check_results + + @health_check_results.setter + def health_check_results(self, health_check_results): + """ + Sets the health_check_results of this BackendHealth. + A list of the most recent health check results returned for the specified backend server. + + + :param health_check_results: The health_check_results of this BackendHealth. + :type: list[HealthCheckResult] + """ + self._health_check_results = health_check_results + + @property + def status(self): + """ + Gets the status of this BackendHealth. + The general health status of the specified backend server as reported by the primary and stand-by load balancers. + + * **OK:** Both health checks returned `OK`. + + * **WARNING:** One health check returned `OK` and one did not. + + * **CRITICAL:** Neither health check returned `OK`. + + * **UNKNOWN:** One or both health checks returned `UNKNOWN`, or the system was unable to retrieve metrics at this time. + + Allowed values for this property are: "OK", "WARNING", "CRITICAL", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this BackendHealth. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this BackendHealth. + The general health status of the specified backend server as reported by the primary and stand-by load balancers. + + * **OK:** Both health checks returned `OK`. + + * **WARNING:** One health check returned `OK` and one did not. + + * **CRITICAL:** Neither health check returned `OK`. + + * **UNKNOWN:** One or both health checks returned `UNKNOWN`, or the system was unable to retrieve metrics at this time. + + + :param status: The status of this BackendHealth. + :type: str + """ + allowed_values = ["OK", "WARNING", "CRITICAL", "UNKNOWN"] + if status not in allowed_values: + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + 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/oraclebmc/load_balancer/models/backend_set.py b/src/oci/load_balancer/models/backend_set.py similarity index 92% rename from src/oraclebmc/load_balancer/models/backend_set.py rename to src/oci/load_balancer/models/backend_set.py index 4657354fa5..2525683670 100644 --- a/src/oraclebmc/load_balancer/models/backend_set.py +++ b/src/oci/load_balancer/models/backend_set.py @@ -80,7 +80,10 @@ def name(self): Gets the name of this BackendSet. A friendly name for the backend set. It must be unique and it cannot be changed. - Example: `My backend set` + 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` :return: The name of this BackendSet. @@ -94,7 +97,10 @@ def name(self, name): Sets the name of this BackendSet. A friendly name for the backend set. It must be unique and it cannot be changed. - Example: `My backend set` + 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` :param name: The name of this BackendSet. diff --git a/src/oraclebmc/load_balancer/models/backend_set_details.py b/src/oci/load_balancer/models/backend_set_details.py similarity index 100% rename from src/oraclebmc/load_balancer/models/backend_set_details.py rename to src/oci/load_balancer/models/backend_set_details.py diff --git a/src/oci/load_balancer/models/backend_set_health.py b/src/oci/load_balancer/models/backend_set_health.py new file mode 100644 index 0000000000..6cd2b0e795 --- /dev/null +++ b/src/oci/load_balancer/models/backend_set_health.py @@ -0,0 +1,212 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class BackendSetHealth(object): + + def __init__(self): + + self.swagger_types = { + 'critical_state_backend_names': 'list[str]', + 'status': 'str', + 'total_backend_count': 'int', + 'unknown_state_backend_names': 'list[str]', + 'warning_state_backend_names': 'list[str]' + } + + self.attribute_map = { + 'critical_state_backend_names': 'criticalStateBackendNames', + 'status': 'status', + 'total_backend_count': 'totalBackendCount', + 'unknown_state_backend_names': 'unknownStateBackendNames', + 'warning_state_backend_names': 'warningStateBackendNames' + } + + self._critical_state_backend_names = None + self._status = None + self._total_backend_count = None + self._unknown_state_backend_names = None + self._warning_state_backend_names = None + + @property + def critical_state_backend_names(self): + """ + Gets the critical_state_backend_names of this BackendSetHealth. + 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` + + + :return: The critical_state_backend_names of this BackendSetHealth. + :rtype: list[str] + """ + return self._critical_state_backend_names + + @critical_state_backend_names.setter + def critical_state_backend_names(self, critical_state_backend_names): + """ + Sets the critical_state_backend_names of this BackendSetHealth. + 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` + + + :param critical_state_backend_names: The critical_state_backend_names of this BackendSetHealth. + :type: list[str] + """ + self._critical_state_backend_names = critical_state_backend_names + + @property + def status(self): + """ + Gets the status of this BackendSetHealth. + Overall health status of the backend set. + + * **OK:** All backend servers in the backend set return a status of `OK`. + + * **WARNING:** Half or more of the backend set's backend servers return a status of `OK` and at least one backend + server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`. + + * **CRITICAL:** Fewer than half of the backend set's backend servers return a status of `OK`. + + * **UNKNOWN:** More than half of the backend set's backend servers return a status of `UNKNOWN`, the system was + unable to retrieve metrics, or the backend set does not have a listener attached. + + Allowed values for this property are: "OK", "WARNING", "CRITICAL", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this BackendSetHealth. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this BackendSetHealth. + Overall health status of the backend set. + + * **OK:** All backend servers in the backend set return a status of `OK`. + + * **WARNING:** Half or more of the backend set's backend servers return a status of `OK` and at least one backend + server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`. + + * **CRITICAL:** Fewer than half of the backend set's backend servers return a status of `OK`. + + * **UNKNOWN:** More than half of the backend set's backend servers return a status of `UNKNOWN`, the system was + unable to retrieve metrics, or the backend set does not have a listener attached. + + + :param status: The status of this BackendSetHealth. + :type: str + """ + allowed_values = ["OK", "WARNING", "CRITICAL", "UNKNOWN"] + if status not in allowed_values: + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def total_backend_count(self): + """ + Gets the total_backend_count of this BackendSetHealth. + The total number of backend servers in this backend set. + + Example: `5` + + + :return: The total_backend_count of this BackendSetHealth. + :rtype: int + """ + return self._total_backend_count + + @total_backend_count.setter + 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` + + + :param total_backend_count: The total_backend_count of this BackendSetHealth. + :type: int + """ + self._total_backend_count = total_backend_count + + @property + def unknown_state_backend_names(self): + """ + Gets the unknown_state_backend_names of this BackendSetHealth. + 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` + + + :return: The unknown_state_backend_names of this BackendSetHealth. + :rtype: list[str] + """ + return self._unknown_state_backend_names + + @unknown_state_backend_names.setter + def unknown_state_backend_names(self, unknown_state_backend_names): + """ + Sets the unknown_state_backend_names of this BackendSetHealth. + 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` + + + :param unknown_state_backend_names: The unknown_state_backend_names of this BackendSetHealth. + :type: list[str] + """ + self._unknown_state_backend_names = unknown_state_backend_names + + @property + def warning_state_backend_names(self): + """ + Gets the warning_state_backend_names of this BackendSetHealth. + 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` + + + :return: The warning_state_backend_names of this BackendSetHealth. + :rtype: list[str] + """ + return self._warning_state_backend_names + + @warning_state_backend_names.setter + def warning_state_backend_names(self, warning_state_backend_names): + """ + Sets the warning_state_backend_names of this BackendSetHealth. + 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` + + + :param warning_state_backend_names: The warning_state_backend_names of this BackendSetHealth. + :type: list[str] + """ + self._warning_state_backend_names = warning_state_backend_names + + 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/oraclebmc/load_balancer/models/certificate.py b/src/oci/load_balancer/models/certificate.py similarity index 91% rename from src/oraclebmc/load_balancer/models/certificate.py rename to src/oci/load_balancer/models/certificate.py index cf19148c9c..c526bd5432 100644 --- a/src/oraclebmc/load_balancer/models/certificate.py +++ b/src/oci/load_balancer/models/certificate.py @@ -74,8 +74,10 @@ def certificate_name(self): """ Gets the certificate_name of this Certificate. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :return: The certificate_name of this Certificate. @@ -88,8 +90,10 @@ def certificate_name(self, certificate_name): """ Sets the certificate_name of this Certificate. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :param certificate_name: The certificate_name of this Certificate. diff --git a/src/oraclebmc/load_balancer/models/certificate_details.py b/src/oci/load_balancer/models/certificate_details.py similarity index 93% rename from src/oraclebmc/load_balancer/models/certificate_details.py rename to src/oci/load_balancer/models/certificate_details.py index 73bd029041..2ecb30aabe 100644 --- a/src/oraclebmc/load_balancer/models/certificate_details.py +++ b/src/oci/load_balancer/models/certificate_details.py @@ -80,8 +80,10 @@ def certificate_name(self): """ Gets the certificate_name of this CertificateDetails. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :return: The certificate_name of this CertificateDetails. @@ -94,8 +96,10 @@ def certificate_name(self, certificate_name): """ Sets the certificate_name of this CertificateDetails. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :param certificate_name: The certificate_name of this CertificateDetails. diff --git a/src/oraclebmc/load_balancer/models/create_backend_details.py b/src/oci/load_balancer/models/create_backend_details.py similarity index 100% rename from src/oraclebmc/load_balancer/models/create_backend_details.py rename to src/oci/load_balancer/models/create_backend_details.py diff --git a/src/oraclebmc/load_balancer/models/create_backend_set_details.py b/src/oci/load_balancer/models/create_backend_set_details.py similarity index 92% rename from src/oraclebmc/load_balancer/models/create_backend_set_details.py rename to src/oci/load_balancer/models/create_backend_set_details.py index d534be0def..b5d6eec95a 100644 --- a/src/oraclebmc/load_balancer/models/create_backend_set_details.py +++ b/src/oci/load_balancer/models/create_backend_set_details.py @@ -80,7 +80,10 @@ def name(self): Gets the name of this CreateBackendSetDetails. A friendly name for the backend set. It must be unique and it cannot be changed. - Example: `My backend set` + 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` :return: The name of this CreateBackendSetDetails. @@ -94,7 +97,10 @@ def name(self, name): Sets the name of this CreateBackendSetDetails. A friendly name for the backend set. It must be unique and it cannot be changed. - Example: `My backend set` + 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` :param name: The name of this CreateBackendSetDetails. diff --git a/src/oraclebmc/load_balancer/models/create_certificate_details.py b/src/oci/load_balancer/models/create_certificate_details.py similarity index 94% rename from src/oraclebmc/load_balancer/models/create_certificate_details.py rename to src/oci/load_balancer/models/create_certificate_details.py index 0f5ee9b77d..548cf79e94 100644 --- a/src/oraclebmc/load_balancer/models/create_certificate_details.py +++ b/src/oci/load_balancer/models/create_certificate_details.py @@ -80,8 +80,10 @@ def certificate_name(self): """ Gets the certificate_name of this CreateCertificateDetails. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :return: The certificate_name of this CreateCertificateDetails. @@ -94,8 +96,10 @@ def certificate_name(self, certificate_name): """ Sets the certificate_name of this CreateCertificateDetails. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :param certificate_name: The certificate_name of this CreateCertificateDetails. diff --git a/src/oraclebmc/load_balancer/models/create_listener_details.py b/src/oci/load_balancer/models/create_listener_details.py similarity index 97% rename from src/oraclebmc/load_balancer/models/create_listener_details.py rename to src/oci/load_balancer/models/create_listener_details.py index 8e1fa05f67..c404a14643 100644 --- a/src/oraclebmc/load_balancer/models/create_listener_details.py +++ b/src/oci/load_balancer/models/create_listener_details.py @@ -60,6 +60,7 @@ def name(self): """ Gets the name of this CreateListenerDetails. A friendly name for the listener. It must be unique and it cannot be changed. + Avoid entering confidential information. Example: `My listener` @@ -74,6 +75,7 @@ def name(self, name): """ Sets the name of this CreateListenerDetails. A friendly name for the listener. It must be unique and it cannot be changed. + Avoid entering confidential information. Example: `My listener` diff --git a/src/oraclebmc/load_balancer/models/create_load_balancer_details.py b/src/oci/load_balancer/models/create_load_balancer_details.py similarity index 99% rename from src/oraclebmc/load_balancer/models/create_load_balancer_details.py rename to src/oci/load_balancer/models/create_load_balancer_details.py index e43c961283..e1d8662fad 100644 --- a/src/oraclebmc/load_balancer/models/create_load_balancer_details.py +++ b/src/oci/load_balancer/models/create_load_balancer_details.py @@ -113,6 +113,7 @@ def display_name(self): """ Gets the display_name of this CreateLoadBalancerDetails. A user-friendly name. It does not have to be unique, and it is changeable. + Avoid entering confidential information. Example: `My load balancer` @@ -127,6 +128,7 @@ def display_name(self, display_name): """ Sets the display_name of this CreateLoadBalancerDetails. A user-friendly name. It does not have to be unique, and it is changeable. + Avoid entering confidential information. Example: `My load balancer` diff --git a/src/oci/load_balancer/models/health_check_result.py b/src/oci/load_balancer/models/health_check_result.py new file mode 100644 index 0000000000..b3a1802c0c --- /dev/null +++ b/src/oci/load_balancer/models/health_check_result.py @@ -0,0 +1,153 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class HealthCheckResult(object): + + def __init__(self): + + self.swagger_types = { + 'health_check_status': 'str', + 'source_ip_address': 'str', + 'subnet_id': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'health_check_status': 'healthCheckStatus', + 'source_ip_address': 'sourceIpAddress', + 'subnet_id': 'subnetId', + 'timestamp': 'timestamp' + } + + self._health_check_status = None + self._source_ip_address = None + self._subnet_id = None + self._timestamp = None + + @property + def health_check_status(self): + """ + Gets the health_check_status of this HealthCheckResult. + The result of the most recent health check. + + Allowed values for this property are: "OK", "INVALID_STATUS_CODE", "TIMED_OUT", "REGEX_MISMATCH", "CONNECT_FAILED", "IO_ERROR", "OFFLINE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The health_check_status of this HealthCheckResult. + :rtype: str + """ + return self._health_check_status + + @health_check_status.setter + def health_check_status(self, health_check_status): + """ + Sets the health_check_status of this HealthCheckResult. + The result of the most recent health check. + + + :param health_check_status: The health_check_status of this HealthCheckResult. + :type: str + """ + allowed_values = ["OK", "INVALID_STATUS_CODE", "TIMED_OUT", "REGEX_MISMATCH", "CONNECT_FAILED", "IO_ERROR", "OFFLINE", "UNKNOWN"] + if health_check_status not in allowed_values: + health_check_status = 'UNKNOWN_ENUM_VALUE' + self._health_check_status = health_check_status + + @property + def source_ip_address(self): + """ + Gets the source_ip_address of this HealthCheckResult. + 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` + + + :return: The source_ip_address of this HealthCheckResult. + :rtype: str + """ + return self._source_ip_address + + @source_ip_address.setter + def source_ip_address(self, source_ip_address): + """ + Sets the source_ip_address of this HealthCheckResult. + 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` + + + :param source_ip_address: The source_ip_address of this HealthCheckResult. + :type: str + """ + self._source_ip_address = source_ip_address + + @property + def subnet_id(self): + """ + Gets the subnet_id of this HealthCheckResult. + The OCID of the subnet hosting the load balancer that reported this health check status. + + + :return: The subnet_id of this HealthCheckResult. + :rtype: str + """ + return self._subnet_id + + @subnet_id.setter + 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. + + + :param subnet_id: The subnet_id of this HealthCheckResult. + :type: str + """ + self._subnet_id = subnet_id + + @property + def timestamp(self): + """ + Gets the timestamp of this HealthCheckResult. + The date and time the data was retrieved, in the format defined by RFC3339. + + Example: `2017-06-02T18:28:11+00:00` + + + :return: The timestamp of this HealthCheckResult. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this HealthCheckResult. + The date and time the data was retrieved, in the format defined by RFC3339. + + Example: `2017-06-02T18:28:11+00:00` + + + :param timestamp: The timestamp of this HealthCheckResult. + :type: datetime + """ + self._timestamp = timestamp + + 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/oraclebmc/load_balancer/models/health_checker.py b/src/oci/load_balancer/models/health_checker.py similarity index 94% rename from src/oraclebmc/load_balancer/models/health_checker.py rename to src/oci/load_balancer/models/health_checker.py index 5108eb10a2..f1b6c4fc95 100644 --- a/src/oraclebmc/load_balancer/models/health_checker.py +++ b/src/oci/load_balancer/models/health_checker.py @@ -216,7 +216,8 @@ def return_code(self, return_code): def timeout_in_millis(self): """ Gets the timeout_in_millis of this HealthChecker. - The maximum timeout before a retry, in milliseconds. Defaults to 3000 (3 seconds). + 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` @@ -230,7 +231,8 @@ def timeout_in_millis(self): def timeout_in_millis(self, timeout_in_millis): """ Sets the timeout_in_millis of this HealthChecker. - The maximum timeout before a retry, in milliseconds. Defaults to 3000 (3 seconds). + 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` diff --git a/src/oraclebmc/load_balancer/models/health_checker_details.py b/src/oci/load_balancer/models/health_checker_details.py similarity index 95% rename from src/oraclebmc/load_balancer/models/health_checker_details.py rename to src/oci/load_balancer/models/health_checker_details.py index 6a5a466c6a..5c739f6a45 100644 --- a/src/oraclebmc/load_balancer/models/health_checker_details.py +++ b/src/oci/load_balancer/models/health_checker_details.py @@ -214,7 +214,8 @@ def return_code(self, return_code): def timeout_in_millis(self): """ Gets the timeout_in_millis of this HealthCheckerDetails. - The maximum timeout in milliseconds before a retry. + 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` @@ -228,7 +229,8 @@ def timeout_in_millis(self): def timeout_in_millis(self, timeout_in_millis): """ Sets the timeout_in_millis of this HealthCheckerDetails. - The maximum timeout in milliseconds before a retry. + 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` diff --git a/src/oraclebmc/load_balancer/models/ip_address.py b/src/oci/load_balancer/models/ip_address.py similarity index 100% rename from src/oraclebmc/load_balancer/models/ip_address.py rename to src/oci/load_balancer/models/ip_address.py diff --git a/src/oraclebmc/load_balancer/models/listener.py b/src/oci/load_balancer/models/listener.py similarity index 100% rename from src/oraclebmc/load_balancer/models/listener.py rename to src/oci/load_balancer/models/listener.py diff --git a/src/oraclebmc/load_balancer/models/listener_details.py b/src/oci/load_balancer/models/listener_details.py similarity index 100% rename from src/oraclebmc/load_balancer/models/listener_details.py rename to src/oci/load_balancer/models/listener_details.py diff --git a/src/oraclebmc/load_balancer/models/load_balancer.py b/src/oci/load_balancer/models/load_balancer.py similarity index 100% rename from src/oraclebmc/load_balancer/models/load_balancer.py rename to src/oci/load_balancer/models/load_balancer.py diff --git a/src/oci/load_balancer/models/load_balancer_health.py b/src/oci/load_balancer/models/load_balancer_health.py new file mode 100644 index 0000000000..8affc02ae3 --- /dev/null +++ b/src/oci/load_balancer/models/load_balancer_health.py @@ -0,0 +1,228 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class LoadBalancerHealth(object): + + def __init__(self): + + self.swagger_types = { + 'critical_state_backend_set_names': 'list[str]', + 'status': 'str', + 'total_backend_set_count': 'int', + 'unknown_state_backend_set_names': 'list[str]', + 'warning_state_backend_set_names': 'list[str]' + } + + self.attribute_map = { + 'critical_state_backend_set_names': 'criticalStateBackendSetNames', + 'status': 'status', + 'total_backend_set_count': 'totalBackendSetCount', + 'unknown_state_backend_set_names': 'unknownStateBackendSetNames', + 'warning_state_backend_set_names': 'warningStateBackendSetNames' + } + + self._critical_state_backend_set_names = None + self._status = None + self._total_backend_set_count = None + self._unknown_state_backend_set_names = None + self._warning_state_backend_set_names = None + + @property + def critical_state_backend_set_names(self): + """ + Gets the critical_state_backend_set_names of this LoadBalancerHealth. + 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` + + + :return: The critical_state_backend_set_names of this LoadBalancerHealth. + :rtype: list[str] + """ + return self._critical_state_backend_set_names + + @critical_state_backend_set_names.setter + def critical_state_backend_set_names(self, critical_state_backend_set_names): + """ + Sets the critical_state_backend_set_names of this LoadBalancerHealth. + 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` + + + :param critical_state_backend_set_names: The critical_state_backend_set_names of this LoadBalancerHealth. + :type: list[str] + """ + self._critical_state_backend_set_names = critical_state_backend_set_names + + @property + def status(self): + """ + Gets the status of this LoadBalancerHealth. + The overall health status of the load balancer. + + * **OK:** All backend sets associated with the load balancer return a status of `OK`. + + * **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`, + no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`. + + * **UNKNOWN:** If any one of the following conditions is true: + + * The load balancer life cycle state is not `ACTIVE`. + + * No backend sets are defined for the load balancer. + + * More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend + sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * The system could not retrieve metrics for any reason. + + Allowed values for this property are: "OK", "WARNING", "CRITICAL", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this LoadBalancerHealth. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this LoadBalancerHealth. + The overall health status of the load balancer. + + * **OK:** All backend sets associated with the load balancer return a status of `OK`. + + * **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`, + no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`. + + * **UNKNOWN:** If any one of the following conditions is true: + + * The load balancer life cycle state is not `ACTIVE`. + + * No backend sets are defined for the load balancer. + + * More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend + sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * The system could not retrieve metrics for any reason. + + + :param status: The status of this LoadBalancerHealth. + :type: str + """ + allowed_values = ["OK", "WARNING", "CRITICAL", "UNKNOWN"] + if status not in allowed_values: + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def total_backend_set_count(self): + """ + Gets the total_backend_set_count of this LoadBalancerHealth. + The total number of backend sets associated with this load balancer. + + Example: `4` + + + :return: The total_backend_set_count of this LoadBalancerHealth. + :rtype: int + """ + return self._total_backend_set_count + + @total_backend_set_count.setter + def total_backend_set_count(self, total_backend_set_count): + """ + Sets the total_backend_set_count of this LoadBalancerHealth. + The total number of backend sets associated with this load balancer. + + Example: `4` + + + :param total_backend_set_count: The total_backend_set_count of this LoadBalancerHealth. + :type: int + """ + self._total_backend_set_count = total_backend_set_count + + @property + def unknown_state_backend_set_names(self): + """ + Gets the unknown_state_backend_set_names of this LoadBalancerHealth. + 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` + + + :return: The unknown_state_backend_set_names of this LoadBalancerHealth. + :rtype: list[str] + """ + return self._unknown_state_backend_set_names + + @unknown_state_backend_set_names.setter + def unknown_state_backend_set_names(self, unknown_state_backend_set_names): + """ + Sets the unknown_state_backend_set_names of this LoadBalancerHealth. + 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` + + + :param unknown_state_backend_set_names: The unknown_state_backend_set_names of this LoadBalancerHealth. + :type: list[str] + """ + self._unknown_state_backend_set_names = unknown_state_backend_set_names + + @property + def warning_state_backend_set_names(self): + """ + Gets the warning_state_backend_set_names of this LoadBalancerHealth. + 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` + + + :return: The warning_state_backend_set_names of this LoadBalancerHealth. + :rtype: list[str] + """ + return self._warning_state_backend_set_names + + @warning_state_backend_set_names.setter + def warning_state_backend_set_names(self, warning_state_backend_set_names): + """ + Sets the warning_state_backend_set_names of this LoadBalancerHealth. + 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` + + + :param warning_state_backend_set_names: The warning_state_backend_set_names of this LoadBalancerHealth. + :type: list[str] + """ + self._warning_state_backend_set_names = warning_state_backend_set_names + + 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/load_balancer_health_summary.py b/src/oci/load_balancer/models/load_balancer_health_summary.py new file mode 100644 index 0000000000..52668a3ede --- /dev/null +++ b/src/oci/load_balancer/models/load_balancer_health_summary.py @@ -0,0 +1,129 @@ +# coding: utf-8 +# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. + + +from ...util import formatted_flat_dict + + +class LoadBalancerHealthSummary(object): + + def __init__(self): + + self.swagger_types = { + 'load_balancer_id': 'str', + 'status': 'str' + } + + self.attribute_map = { + 'load_balancer_id': 'loadBalancerId', + 'status': 'status' + } + + self._load_balancer_id = None + self._status = None + + @property + def load_balancer_id(self): + """ + Gets the load_balancer_id of this LoadBalancerHealthSummary. + The `OCID`__ of the load balancer the health status is associated with. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + + :return: The load_balancer_id of this LoadBalancerHealthSummary. + :rtype: str + """ + return self._load_balancer_id + + @load_balancer_id.setter + def load_balancer_id(self, load_balancer_id): + """ + Sets the load_balancer_id of this LoadBalancerHealthSummary. + The `OCID`__ of the load balancer the health status is associated with. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + + + :param load_balancer_id: The load_balancer_id of this LoadBalancerHealthSummary. + :type: str + """ + self._load_balancer_id = load_balancer_id + + @property + def status(self): + """ + Gets the status of this LoadBalancerHealthSummary. + The overall health status of the load balancer. + + * **OK:** All backend sets associated with the load balancer return a status of `OK`. + + * **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`, + no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`. + + * **UNKNOWN:** If any one of the following conditions is true: + + * The load balancer life cycle state is not `ACTIVE`. + + * No backend sets are defined for the load balancer. + + * More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend + sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * The system could not retrieve metrics for any reason. + + Allowed values for this property are: "OK", "WARNING", "CRITICAL", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this LoadBalancerHealthSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this LoadBalancerHealthSummary. + The overall health status of the load balancer. + + * **OK:** All backend sets associated with the load balancer return a status of `OK`. + + * **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`, + no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`. + + * **UNKNOWN:** If any one of the following conditions is true: + + * The load balancer life cycle state is not `ACTIVE`. + + * No backend sets are defined for the load balancer. + + * More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend + sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * The system could not retrieve metrics for any reason. + + + :param status: The status of this LoadBalancerHealthSummary. + :type: str + """ + allowed_values = ["OK", "WARNING", "CRITICAL", "UNKNOWN"] + if status not in allowed_values: + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + 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/oraclebmc/load_balancer/models/load_balancer_policy.py b/src/oci/load_balancer/models/load_balancer_policy.py similarity index 100% rename from src/oraclebmc/load_balancer/models/load_balancer_policy.py rename to src/oci/load_balancer/models/load_balancer_policy.py diff --git a/src/oraclebmc/load_balancer/models/load_balancer_protocol.py b/src/oci/load_balancer/models/load_balancer_protocol.py similarity index 100% rename from src/oraclebmc/load_balancer/models/load_balancer_protocol.py rename to src/oci/load_balancer/models/load_balancer_protocol.py diff --git a/src/oraclebmc/load_balancer/models/load_balancer_shape.py b/src/oci/load_balancer/models/load_balancer_shape.py similarity index 100% rename from src/oraclebmc/load_balancer/models/load_balancer_shape.py rename to src/oci/load_balancer/models/load_balancer_shape.py diff --git a/src/oraclebmc/load_balancer/models/session_persistence_configuration_details.py b/src/oci/load_balancer/models/session_persistence_configuration_details.py similarity index 100% rename from src/oraclebmc/load_balancer/models/session_persistence_configuration_details.py rename to src/oci/load_balancer/models/session_persistence_configuration_details.py diff --git a/src/oraclebmc/load_balancer/models/ssl_configuration.py b/src/oci/load_balancer/models/ssl_configuration.py similarity index 87% rename from src/oraclebmc/load_balancer/models/ssl_configuration.py rename to src/oci/load_balancer/models/ssl_configuration.py index e2428a4391..bf51ee7d51 100644 --- a/src/oraclebmc/load_balancer/models/ssl_configuration.py +++ b/src/oci/load_balancer/models/ssl_configuration.py @@ -30,8 +30,10 @@ def certificate_name(self): """ Gets the certificate_name of this SSLConfiguration. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :return: The certificate_name of this SSLConfiguration. @@ -44,8 +46,10 @@ def certificate_name(self, certificate_name): """ Sets the certificate_name of this SSLConfiguration. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :param certificate_name: The certificate_name of this SSLConfiguration. diff --git a/src/oraclebmc/load_balancer/models/ssl_configuration_details.py b/src/oci/load_balancer/models/ssl_configuration_details.py similarity index 87% rename from src/oraclebmc/load_balancer/models/ssl_configuration_details.py rename to src/oci/load_balancer/models/ssl_configuration_details.py index a7f348cdec..d8ab6aec44 100644 --- a/src/oraclebmc/load_balancer/models/ssl_configuration_details.py +++ b/src/oci/load_balancer/models/ssl_configuration_details.py @@ -30,8 +30,10 @@ def certificate_name(self): """ Gets the certificate_name of this SSLConfigurationDetails. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :return: The certificate_name of this SSLConfigurationDetails. @@ -44,8 +46,10 @@ def certificate_name(self, certificate_name): """ Sets the certificate_name of this SSLConfigurationDetails. A friendly name for the certificate bundle. It must be unique and it cannot be changed. + 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: `My_certificate_bundle` :param certificate_name: The certificate_name of this SSLConfigurationDetails. diff --git a/src/oraclebmc/load_balancer/models/update_backend_details.py b/src/oci/load_balancer/models/update_backend_details.py similarity index 100% rename from src/oraclebmc/load_balancer/models/update_backend_details.py rename to src/oci/load_balancer/models/update_backend_details.py diff --git a/src/oraclebmc/load_balancer/models/update_backend_set_details.py b/src/oci/load_balancer/models/update_backend_set_details.py similarity index 100% rename from src/oraclebmc/load_balancer/models/update_backend_set_details.py rename to src/oci/load_balancer/models/update_backend_set_details.py diff --git a/src/oraclebmc/load_balancer/models/update_health_checker_details.py b/src/oci/load_balancer/models/update_health_checker_details.py similarity index 95% rename from src/oraclebmc/load_balancer/models/update_health_checker_details.py rename to src/oci/load_balancer/models/update_health_checker_details.py index cdeb597f1d..7322df04e3 100644 --- a/src/oraclebmc/load_balancer/models/update_health_checker_details.py +++ b/src/oci/load_balancer/models/update_health_checker_details.py @@ -212,7 +212,8 @@ def return_code(self, return_code): def timeout_in_millis(self): """ Gets the timeout_in_millis of this UpdateHealthCheckerDetails. - The maximum timeout in milliseconds before a retry. + 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` @@ -226,7 +227,8 @@ def timeout_in_millis(self): def timeout_in_millis(self, timeout_in_millis): """ Sets the timeout_in_millis of this UpdateHealthCheckerDetails. - The maximum timeout in milliseconds before a retry. + 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` diff --git a/src/oraclebmc/load_balancer/models/update_listener_details.py b/src/oci/load_balancer/models/update_listener_details.py similarity index 100% rename from src/oraclebmc/load_balancer/models/update_listener_details.py rename to src/oci/load_balancer/models/update_listener_details.py diff --git a/src/oraclebmc/load_balancer/models/update_load_balancer_details.py b/src/oci/load_balancer/models/update_load_balancer_details.py similarity index 93% rename from src/oraclebmc/load_balancer/models/update_load_balancer_details.py rename to src/oci/load_balancer/models/update_load_balancer_details.py index 66ab1b77d7..8c081ccd6b 100644 --- a/src/oraclebmc/load_balancer/models/update_load_balancer_details.py +++ b/src/oci/load_balancer/models/update_load_balancer_details.py @@ -24,6 +24,7 @@ def display_name(self): """ Gets the display_name of this UpdateLoadBalancerDetails. 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` @@ -38,6 +39,7 @@ def display_name(self, display_name): """ Sets the display_name of this UpdateLoadBalancerDetails. 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` diff --git a/src/oraclebmc/load_balancer/models/work_request.py b/src/oci/load_balancer/models/work_request.py similarity index 100% rename from src/oraclebmc/load_balancer/models/work_request.py rename to src/oci/load_balancer/models/work_request.py diff --git a/src/oraclebmc/load_balancer/models/work_request_error.py b/src/oci/load_balancer/models/work_request_error.py similarity index 100% rename from src/oraclebmc/load_balancer/models/work_request_error.py rename to src/oci/load_balancer/models/work_request_error.py diff --git a/src/oraclebmc/object_storage/__init__.py b/src/oci/object_storage/__init__.py similarity index 100% rename from src/oraclebmc/object_storage/__init__.py rename to src/oci/object_storage/__init__.py diff --git a/src/oraclebmc/object_storage/models/__init__.py b/src/oci/object_storage/models/__init__.py similarity index 100% rename from src/oraclebmc/object_storage/models/__init__.py rename to src/oci/object_storage/models/__init__.py diff --git a/src/oraclebmc/object_storage/models/bucket.py b/src/oci/object_storage/models/bucket.py similarity index 100% rename from src/oraclebmc/object_storage/models/bucket.py rename to src/oci/object_storage/models/bucket.py diff --git a/src/oraclebmc/object_storage/models/bucket_summary.py b/src/oci/object_storage/models/bucket_summary.py similarity index 100% rename from src/oraclebmc/object_storage/models/bucket_summary.py rename to src/oci/object_storage/models/bucket_summary.py diff --git a/src/oraclebmc/object_storage/models/commit_multipart_upload_details.py b/src/oci/object_storage/models/commit_multipart_upload_details.py similarity index 100% rename from src/oraclebmc/object_storage/models/commit_multipart_upload_details.py rename to src/oci/object_storage/models/commit_multipart_upload_details.py diff --git a/src/oraclebmc/object_storage/models/commit_multipart_upload_part_details.py b/src/oci/object_storage/models/commit_multipart_upload_part_details.py similarity index 100% rename from src/oraclebmc/object_storage/models/commit_multipart_upload_part_details.py rename to src/oci/object_storage/models/commit_multipart_upload_part_details.py diff --git a/src/oraclebmc/object_storage/models/create_bucket_details.py b/src/oci/object_storage/models/create_bucket_details.py similarity index 100% rename from src/oraclebmc/object_storage/models/create_bucket_details.py rename to src/oci/object_storage/models/create_bucket_details.py diff --git a/src/oraclebmc/object_storage/models/create_multipart_upload_details.py b/src/oci/object_storage/models/create_multipart_upload_details.py similarity index 100% rename from src/oraclebmc/object_storage/models/create_multipart_upload_details.py rename to src/oci/object_storage/models/create_multipart_upload_details.py diff --git a/src/oraclebmc/object_storage/models/create_preauthenticated_request_details.py b/src/oci/object_storage/models/create_preauthenticated_request_details.py similarity index 100% rename from src/oraclebmc/object_storage/models/create_preauthenticated_request_details.py rename to src/oci/object_storage/models/create_preauthenticated_request_details.py diff --git a/src/oraclebmc/object_storage/models/list_objects.py b/src/oci/object_storage/models/list_objects.py similarity index 100% rename from src/oraclebmc/object_storage/models/list_objects.py rename to src/oci/object_storage/models/list_objects.py diff --git a/src/oraclebmc/object_storage/models/multipart_upload.py b/src/oci/object_storage/models/multipart_upload.py similarity index 100% rename from src/oraclebmc/object_storage/models/multipart_upload.py rename to src/oci/object_storage/models/multipart_upload.py diff --git a/src/oraclebmc/object_storage/models/multipart_upload_part_summary.py b/src/oci/object_storage/models/multipart_upload_part_summary.py similarity index 100% rename from src/oraclebmc/object_storage/models/multipart_upload_part_summary.py rename to src/oci/object_storage/models/multipart_upload_part_summary.py diff --git a/src/oraclebmc/object_storage/models/object_summary.py b/src/oci/object_storage/models/object_summary.py similarity index 100% rename from src/oraclebmc/object_storage/models/object_summary.py rename to src/oci/object_storage/models/object_summary.py diff --git a/src/oraclebmc/object_storage/models/preauthenticated_request.py b/src/oci/object_storage/models/preauthenticated_request.py similarity index 100% rename from src/oraclebmc/object_storage/models/preauthenticated_request.py rename to src/oci/object_storage/models/preauthenticated_request.py diff --git a/src/oraclebmc/object_storage/models/preauthenticated_request_summary.py b/src/oci/object_storage/models/preauthenticated_request_summary.py similarity index 100% rename from src/oraclebmc/object_storage/models/preauthenticated_request_summary.py rename to src/oci/object_storage/models/preauthenticated_request_summary.py diff --git a/src/oraclebmc/object_storage/models/update_bucket_details.py b/src/oci/object_storage/models/update_bucket_details.py similarity index 100% rename from src/oraclebmc/object_storage/models/update_bucket_details.py rename to src/oci/object_storage/models/update_bucket_details.py diff --git a/src/oraclebmc/object_storage/object_storage_client.py b/src/oci/object_storage/object_storage_client.py similarity index 93% rename from src/oraclebmc/object_storage/object_storage_client.py rename to src/oci/object_storage/object_storage_client.py index aa6d2195da..113eba2eeb 100644 --- a/src/oraclebmc/object_storage/object_storage_client.py +++ b/src/oci/object_storage/object_storage_client.py @@ -51,8 +51,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/u/{objectName}" method = "DELETE" @@ -129,8 +129,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/u/{objectName}" method = "POST" @@ -196,8 +196,8 @@ def create_bucket(self, namespace_name, create_bucket_details, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.object_storage.models.Bucket` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.Bucket` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/" method = "POST" @@ -260,8 +260,8 @@ def create_multipart_upload(self, namespace_name, bucket_name, create_multipart_ :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.object_storage.models.MultipartUpload` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.MultipartUpload` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/u" method = "POST" @@ -320,8 +320,8 @@ def create_preauthenticated_request(self, namespace_name, bucket_name, create_pr :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.object_storage.models.PreauthenticatedRequest` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.PreauthenticatedRequest` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/p/" method = "POST" @@ -377,8 +377,8 @@ def delete_bucket(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/" method = "DELETE" @@ -439,8 +439,8 @@ def delete_object(self, namespace_name, bucket_name, object_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/o/{objectName}" method = "DELETE" @@ -497,8 +497,8 @@ def delete_preauthenticated_request(self, namespace_name, bucket_name, par_id, * :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/p/{parId}" method = "DELETE" @@ -558,8 +558,8 @@ def get_bucket(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.object_storage.models.Bucket` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.Bucket` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/" method = "GET" @@ -607,8 +607,8 @@ def get_namespace(self, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type str - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type str + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/" method = "GET" @@ -672,8 +672,8 @@ def get_object(self, namespace_name, bucket_name, object_name, **kwargs): __ https://tools.ietf.org/rfc/rfc7233 - :return: A :class:`~oraclebmc.response.Response` object with data of type stream - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type stream + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/o/{objectName}" method = "GET" @@ -735,8 +735,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.object_storage.models.PreauthenticatedRequestSummary` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.PreauthenticatedRequestSummary` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/p/{parId}" method = "GET" @@ -797,8 +797,8 @@ def head_bucket(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/" method = "HEAD" @@ -866,8 +866,8 @@ def head_object(self, namespace_name, bucket_name, object_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/o/{objectName}" method = "HEAD" @@ -933,8 +933,8 @@ def list_buckets(self, namespace_name, compartment_id, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.object_storage.models.BucketSummary` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.object_storage.models.BucketSummary` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/" method = "GET" @@ -1008,8 +1008,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.object_storage.models.MultipartUploadPartSummary` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.object_storage.models.MultipartUploadPartSummary` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/u/{objectName}" method = "GET" @@ -1077,8 +1077,8 @@ def list_multipart_uploads(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.object_storage.models.MultipartUpload` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.object_storage.models.MultipartUpload` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/u" method = "GET" @@ -1169,8 +1169,8 @@ def list_objects(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.object_storage.models.ListObjects` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.ListObjects` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/o" method = "GET" @@ -1247,8 +1247,8 @@ def list_preauthenticated_requests(self, namespace_name, bucket_name, **kwargs): :param str opc_client_request_id: (optional) The client request ID for tracing. - :return: A :class:`~oraclebmc.response.Response` object with data of type list of :class:`~oraclebmc.object_storage.models.PreauthenticatedRequestSummary` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.object_storage.models.PreauthenticatedRequestSummary` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/p/" method = "GET" @@ -1354,8 +1354,8 @@ def put_object(self, namespace_name, bucket_name, object_name, put_object_body, :param dict(str, str) opc_meta: (optional) Optional user-defined metadata key and value. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/o/{objectName}" method = "PUT" @@ -1438,8 +1438,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type :class:`~oraclebmc.object_storage.models.Bucket` - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.object_storage.models.Bucket` + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/" method = "POST" @@ -1525,8 +1525,8 @@ 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. - :return: A :class:`~oraclebmc.response.Response` object with data of type None - :rtype: :class:`~oraclebmc.response.Response` + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` """ resource_path = "/n/{namespaceName}/b/{bucketName}/u/{objectName}" method = "PUT" diff --git a/src/oraclebmc/object_storage/transfer/__init__.py b/src/oci/object_storage/transfer/__init__.py similarity index 100% rename from src/oraclebmc/object_storage/transfer/__init__.py rename to src/oci/object_storage/transfer/__init__.py diff --git a/src/oraclebmc/object_storage/transfer/constants.py b/src/oci/object_storage/transfer/constants.py similarity index 100% rename from src/oraclebmc/object_storage/transfer/constants.py rename to src/oci/object_storage/transfer/constants.py diff --git a/src/oraclebmc/object_storage/transfer/internal/__init__.py b/src/oci/object_storage/transfer/internal/__init__.py similarity index 100% rename from src/oraclebmc/object_storage/transfer/internal/__init__.py rename to src/oci/object_storage/transfer/internal/__init__.py diff --git a/src/oraclebmc/object_storage/transfer/internal/buffered_part_reader.py b/src/oci/object_storage/transfer/internal/buffered_part_reader.py similarity index 100% rename from src/oraclebmc/object_storage/transfer/internal/buffered_part_reader.py rename to src/oci/object_storage/transfer/internal/buffered_part_reader.py diff --git a/src/oraclebmc/object_storage/transfer/internal/file_read_callback_stream.py b/src/oci/object_storage/transfer/internal/file_read_callback_stream.py similarity index 100% rename from src/oraclebmc/object_storage/transfer/internal/file_read_callback_stream.py rename to src/oci/object_storage/transfer/internal/file_read_callback_stream.py diff --git a/src/oraclebmc/object_storage/transfer/internal/multipart_object_assembler.py b/src/oci/object_storage/transfer/internal/multipart_object_assembler.py similarity index 100% rename from src/oraclebmc/object_storage/transfer/internal/multipart_object_assembler.py rename to src/oci/object_storage/transfer/internal/multipart_object_assembler.py diff --git a/src/oraclebmc/object_storage/transfer/upload_manager.py b/src/oci/object_storage/transfer/upload_manager.py similarity index 100% rename from src/oraclebmc/object_storage/transfer/upload_manager.py rename to src/oci/object_storage/transfer/upload_manager.py diff --git a/src/oraclebmc/regions.py b/src/oci/regions.py similarity index 89% rename from src/oraclebmc/regions.py rename to src/oci/regions.py index 309bf42378..b44270ed71 100644 --- a/src/oraclebmc/regions.py +++ b/src/oci/regions.py @@ -6,12 +6,13 @@ "us-ashburn-1" ] SERVICE_ENDPOINTS = { - "identity": "https://identity.{domain}/20160918", "blockstorage": "https://iaas.{domain}/20160918", "compute": "https://iaas.{domain}/20160918", - "virtual_network": "https://iaas.{domain}/20160918", + "database": "https://database.{domain}/20160918", + "identity": "https://identity.{domain}/20160918", + "load_balancer": "https://iaas.{domain}/20170115", "object_storage": "https://objectstorage.{domain}", - "load_balancer": "https://iaas.{domain}/20170115" + "virtual_network": "https://iaas.{domain}/20160918" } DOMAIN_FORMAT = "{region}.oraclecloud.com" diff --git a/src/oraclebmc/request.py b/src/oci/request.py similarity index 100% rename from src/oraclebmc/request.py rename to src/oci/request.py diff --git a/src/oraclebmc/response.py b/src/oci/response.py similarity index 96% rename from src/oraclebmc/response.py rename to src/oci/response.py index d22a239825..cd90e00d9c 100644 --- a/src/oraclebmc/response.py +++ b/src/oci/response.py @@ -29,7 +29,7 @@ def __init__(self, status, headers, data, request): """ The corresponding request for this response. - :type: :class:`~oraclebmc.request.Request` + :type: :class:`~oci.request.Request` """ self.next_page = None diff --git a/src/oraclebmc/signer.py b/src/oci/signer.py similarity index 99% rename from src/oraclebmc/signer.py rename to src/oci/signer.py index 8e858ddaf7..ad003ccffc 100644 --- a/src/oraclebmc/signer.py +++ b/src/oci/signer.py @@ -138,7 +138,7 @@ class Signer(requests.auth.AuthBase): .. code-block:: python import requests - from oraclebmc import Signer + from oci import Signer auth = Signer(...) resp = requests.get("https://...", auth=auth) diff --git a/src/oraclebmc/util.py b/src/oci/util.py similarity index 100% rename from src/oraclebmc/util.py rename to src/oci/util.py diff --git a/src/oraclebmc/version.py b/src/oci/version.py similarity index 81% rename from src/oraclebmc/version.py rename to src/oci/version.py index c75f29e72e..a652b43724 100644 --- a/src/oraclebmc/version.py +++ b/src/oci/version.py @@ -1,4 +1,4 @@ # coding: utf-8 # Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved. -__version__ = "1.3.6" +__version__ = "1.3.7" diff --git a/src/oraclebmc/waiter.py b/src/oci/waiter.py similarity index 100% rename from src/oraclebmc/waiter.py rename to src/oci/waiter.py diff --git a/tests/conftest.py b/tests/conftest.py index f57d9e34e7..470a501f6f 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,7 +1,8 @@ import os import pytest -import oraclebmc +import oci +from tests.integ import util from tests.util import get_resource_path @@ -10,7 +11,7 @@ def pytest_addoption(parser): default=get_resource_path('config')) parser.addoption("--config-profile", action="store", help="profile to use from the config file", - default=oraclebmc.config.DEFAULT_PROFILE) + default=oci.config.DEFAULT_PROFILE) @pytest.fixture @@ -25,38 +26,50 @@ def config_profile(request): @pytest.fixture def config(config_file, config_profile): - config = oraclebmc.config.from_file(file_location=config_file, profile_name=config_profile) + config = oci.config.from_file(file_location=config_file, profile_name=config_profile) + util.target_region = config['region'] + pass_phrase = os.environ.get('PYTHON_TESTS_ADMIN_PASS_PHRASE') if pass_phrase: config['pass_phrase'] = pass_phrase + + util.init_availability_domain_variables(oci.identity.IdentityClient(config), config['tenancy']) + return config @pytest.fixture def object_storage(config): - return oraclebmc.object_storage.ObjectStorageClient(config) + return oci.object_storage.ObjectStorageClient(config) @pytest.fixture -def identity(config): - return oraclebmc.identity.IdentityClient(config) +def identity(config_file): + # Identity throws an error if we do things from not our home region (currently PHX). So use the default profile here, regardless + # of any command line switches, under the tacit assumption that the default profile points to our home region + return oci.identity.IdentityClient(config(config_file, oci.config.DEFAULT_PROFILE)) @pytest.fixture def block_storage(config): - return oraclebmc.core.BlockstorageClient(config) + return oci.core.BlockstorageClient(config) @pytest.fixture def compute(config): - return oraclebmc.core.ComputeClient(config) + return oci.core.ComputeClient(config) @pytest.fixture def virtual_network(config): - return oraclebmc.core.VirtualNetworkClient(config) + return oci.core.VirtualNetworkClient(config) @pytest.fixture def load_balancer_client(config): - return oraclebmc.load_balancer.LoadBalancerClient(config) + return oci.load_balancer.LoadBalancerClient(config) + + +@pytest.fixture +def database_client(config): + return oci.database.DatabaseClient(config) diff --git a/tests/integ/test_large_file_transfer.py b/tests/integ/test_large_file_transfer.py index 7832cc6352..d11e0b330e 100644 --- a/tests/integ/test_large_file_transfer.py +++ b/tests/integ/test_large_file_transfer.py @@ -1,9 +1,11 @@ import tests.util -import oraclebmc +import oci import io import os import pytest +from . import util + @pytest.fixture def namespace(object_storage): @@ -14,7 +16,7 @@ def namespace(object_storage): def names(): return { "read-object": "reallyLargeFile.dat", - "read-bucket": "ReadOnlyTestBucket4", + "read-bucket": util.bucket_prefix() + "ReadOnlyTestBucket4", "write-object": "file_test", "write-bucket": tests.util.unique_name("test_python_streaming"), "temp-file": tests.util.get_resource_directory() + "/file_download_test_temp_file.dat" @@ -23,7 +25,7 @@ def names(): @pytest.yield_fixture def write_bucket(namespace, object_storage, config, names): - request = oraclebmc.object_storage.models.CreateBucketDetails() + request = oci.object_storage.models.CreateBucketDetails() request.name = names["write-bucket"] request.compartment_id = config["tenancy"] response = object_storage.create_bucket(namespace, request) diff --git a/tests/integ/test_launch_instance_tutorial.py b/tests/integ/test_launch_instance_tutorial.py index 8654ecab4a..48f87f7ffc 100644 --- a/tests/integ/test_launch_instance_tutorial.py +++ b/tests/integ/test_launch_instance_tutorial.py @@ -1,18 +1,17 @@ import tests.util -import oraclebmc +import oci import time import pytest +from . import util + def test_tutorial(virtual_network, compute, block_storage, config): test_id = tests.util.random_number_string() print('Running Launching Your First Instance tutorial') print('Objects will have ID ' + test_id) - # TODO DEX-17: Currently this test only runs against R2 and - # if you have the private and public key files. We should be - # getting these dynamically based on a specified environment. - availability_domain = 'kIdk:PHX-AD-2' + availability_domain = util.availability_domain() compartment = config["tenancy"] with open(tests.util.get_key_file_path("public_ssh_key.pub")) as f: @@ -58,7 +57,7 @@ def test_tutorial(virtual_network, compute, block_storage, config): def create_cloud_network(virtual_network, compartment, test_id): print('Creating cloud network') - request = oraclebmc.core.models.CreateVcnDetails() + request = oci.core.models.CreateVcnDetails() request.cidr_block = '10.0.0.0/16' request.display_name = 'pythonsdk_test_vcn_' + test_id request.compartment_id = compartment @@ -66,10 +65,10 @@ def create_cloud_network(virtual_network, compartment, test_id): response = virtual_network.create_vcn(request) assert response.status == 200 - assert type(response.data) is oraclebmc.core.models.Vcn + assert type(response.data) is oci.core.models.Vcn response = virtual_network.get_vcn(response.data.id) - vcn = oraclebmc.wait_until( + vcn = oci.wait_until( virtual_network, response, 'lifecycle_state', @@ -85,9 +84,9 @@ def delete_cloud_network(virtual_network, vcn): response = virtual_network.delete_vcn(vcn.id) assert response.status == 204 - with pytest.raises(oraclebmc.exceptions.ServiceError) as excinfo: + with pytest.raises(oci.exceptions.ServiceError) as excinfo: response = virtual_network.get_vcn(vcn.id) - oraclebmc.wait_until( + oci.wait_until( virtual_network, response, 'lifecycle_state', @@ -99,7 +98,7 @@ def delete_cloud_network(virtual_network, vcn): def create_subnet(virtual_network, compartment, test_id, availability_domain, vcn): print('Creating subnet') - request = oraclebmc.core.models.CreateSubnetDetails() + request = oci.core.models.CreateSubnetDetails() request.cidr_block = '10.0.0.0/16' request.availability_domain = availability_domain request.display_name = 'pythonsdk_test_subnet_' + test_id @@ -109,10 +108,10 @@ def create_subnet(virtual_network, compartment, test_id, availability_domain, vc response = virtual_network.create_subnet(request) assert response.status == 200 - assert type(response.data) is oraclebmc.core.models.Subnet + assert type(response.data) is oci.core.models.Subnet response = virtual_network.get_subnet(response.data.id) - subnet = oraclebmc.wait_until( + subnet = oci.wait_until( virtual_network, response, 'lifecycle_state', @@ -126,9 +125,9 @@ def delete_subnet(virtual_network, subnet): response = virtual_network.delete_subnet(subnet.id) assert response.status == 204 - with pytest.raises(oraclebmc.exceptions.ServiceError) as excinfo: + with pytest.raises(oci.exceptions.ServiceError) as excinfo: response = virtual_network.get_subnet(subnet.id) - oraclebmc.wait_until( + oci.wait_until( virtual_network, response, 'lifecycle_state', @@ -139,7 +138,7 @@ def delete_subnet(virtual_network, subnet): def create_internet_gateway(virtual_network, compartment, test_id, vcn): print('Creating internet gateway') - request = oraclebmc.core.models.CreateInternetGatewayDetails() + request = oci.core.models.CreateInternetGatewayDetails() request.display_name = 'pythonsdk_test_ig_' + test_id request.compartment_id = compartment request.is_enabled = True @@ -147,10 +146,10 @@ def create_internet_gateway(virtual_network, compartment, test_id, vcn): response = virtual_network.create_internet_gateway(request) assert response.status == 200 - assert type(response.data) is oraclebmc.core.models.InternetGateway + assert type(response.data) is oci.core.models.InternetGateway response = virtual_network.get_internet_gateway(response.data.id) - gateway = oraclebmc.wait_until( + gateway = oci.wait_until( virtual_network, response, 'lifecycle_state', @@ -162,32 +161,32 @@ def create_internet_gateway(virtual_network, compartment, test_id, vcn): def update_route_table(virtual_network, test_id, vcn, gateway): print('Updating route table') - route_rule = oraclebmc.core.models.RouteRule() + route_rule = oci.core.models.RouteRule() route_rule.cidr_block = '0.0.0.0/0' route_rule.display_name = 'pythonsdk_route_rule_' + test_id route_rule.network_entity_id = gateway.id route_rule.network_entity_type = 'INTERNET_GATEWAY' - request = oraclebmc.core.models.UpdateRouteTableDetails() + request = oci.core.models.UpdateRouteTableDetails() request.route_rules = [route_rule] response = virtual_network.update_route_table(vcn.default_route_table_id, request) assert response.status == 200 - assert type(response.data) is oraclebmc.core.models.RouteTable + assert type(response.data) is oci.core.models.RouteTable response = virtual_network.get_route_table(vcn.default_route_table_id) - oraclebmc.wait_until(virtual_network, response, 'lifecycle_state', 'AVAILABLE') + oci.wait_until(virtual_network, response, 'lifecycle_state', 'AVAILABLE') def launch_instance(compute, compartment, test_id, availability_domain, subnet, public_key): print('Launching instance') - request = oraclebmc.core.models.LaunchInstanceDetails() + request = oci.core.models.LaunchInstanceDetails() request.availability_domain = availability_domain request.compartment_id = compartment request.display_name = 'pythonsdk_tutorial_instance_' + test_id # Oracle-Linux-7.3-2017.03.03-0 - request.image_id = 'ocid1.image.oc1.phx.aaaaaaaaevkccuto7ja4yhahz6rguhqbuomimqsig6sgxd55hjomzepyeqda' + request.image_id = util.oracle_linux_image() request.shape = 'VM.Standard1.2' request.subnet_id = subnet.id request.metadata = {'ssh_authorized_keys': public_key} @@ -197,7 +196,7 @@ def launch_instance(compute, compartment, test_id, availability_domain, subnet, assert 'PROVISIONING' == response.data.lifecycle_state response = compute.get_instance(response.data.id) - instance = oraclebmc.wait_until( + instance = oci.wait_until( compute, response, 'lifecycle_state', @@ -215,12 +214,12 @@ def terminate_instance(compute, instance): assert response.status == 204 response = compute.get_instance(instance.id) - oraclebmc.wait_until(compute, response, 'lifecycle_state', 'TERMINATED') + oci.wait_until(compute, response, 'lifecycle_state', 'TERMINATED') def create_volume(block_storage, compartment, test_id, availability_domain): print('Creating volume') - request = oraclebmc.core.models.CreateVolumeDetails() + request = oci.core.models.CreateVolumeDetails() request.display_name = 'pythonsdk_volume_' + test_id request.compartment_id = compartment request.availability_domain = availability_domain @@ -228,10 +227,10 @@ def create_volume(block_storage, compartment, test_id, availability_domain): request, opc_retry_token='testtoken' + test_id) assert response.status == 200 - assert type(response.data) is oraclebmc.core.models.Volume + assert type(response.data) is oci.core.models.Volume response = block_storage.get_volume(response.data.id) - volume = oraclebmc.wait_until( + volume = oci.wait_until( block_storage, response, 'lifecycle_state', @@ -247,7 +246,7 @@ def delete_volume(block_storage, volume): assert response.status == 204 response = block_storage.get_volume(volume.id) - oraclebmc.wait_until( + oci.wait_until( block_storage, response, 'lifecycle_state', @@ -267,7 +266,7 @@ def log_public_ip_address(compute, virtual_network, compartment, instance): # Just get the address for the first vnic attachment. response = virtual_network.get_vnic(vnic_attachment.vnic_id) - response = oraclebmc.wait_until( + response = oci.wait_until( virtual_network, response, 'lifecycle_state', @@ -280,17 +279,17 @@ def log_public_ip_address(compute, virtual_network, compartment, instance): def attach_volume(compute, compartment, instance, volume): print('Attaching volume') - request = oraclebmc.core.models.AttachIScsiVolumeDetails() + request = oci.core.models.AttachIScsiVolumeDetails() request.compartment_id = compartment request.instance_id = instance.id request.volume_id = volume.id response = compute.attach_volume(request) assert response.status == 200 - assert type(response.data) is oraclebmc.core.models.IScsiVolumeAttachment + assert type(response.data) is oci.core.models.IScsiVolumeAttachment response = compute.get_volume_attachment(response.data.id) - attachment = oraclebmc.wait_until( + attachment = oci.wait_until( compute, response, 'lifecycle_state', @@ -305,4 +304,4 @@ def detach_volume(compute, attachment): assert response.status == 204 response = compute.get_volume_attachment(attachment.id) - oraclebmc.wait_until(compute, response, 'lifecycle_state', 'DETACHED') + oci.wait_until(compute, response, 'lifecycle_state', 'DETACHED') diff --git a/tests/util.py b/tests/util.py index 5b8d0dbf2e..6da0f8fa50 100644 --- a/tests/util.py +++ b/tests/util.py @@ -1,5 +1,5 @@ import random -import oraclebmc +import oci import os.path import time import resource @@ -46,7 +46,7 @@ def max_memory_usage(): def validate_service_error(error, status, code, message): - assert isinstance(error, oraclebmc.exceptions.ServiceError) + assert isinstance(error, oci.exceptions.ServiceError) assert error.status == status assert error.code == code assert error.message.startswith(message)