oci 2.135.2__py3-none-any.whl → 2.136.0__py3-none-any.whl

oci/fusion_apps/service_attachment_client.py

@@ -1,370 +0,0 @@
-# coding: utf-8
-# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
-# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
-
-from __future__ import absolute_import
-
-from oci._vendor import requests  # noqa: F401
-from oci._vendor import six
-
-from oci import retry, circuit_breaker  # noqa: F401
-from oci.base_client import BaseClient
-from oci.config import get_config_value_or_default, validate_config
-from oci.signer import Signer
-from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME
-from .models import fusion_apps_type_mapping
-missing = Sentinel("Missing")
-
-
-class ServiceAttachmentClient(object):
-    """
-    Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/Identity/fusion-applications/home.htm).
-    """
-
-    def __init__(self, config, **kwargs):
-        """
-        Creates a new service client
-
-        :param dict config:
-            Configuration keys and values as per `SDK and Tool Configuration <https://docs.cloud.oracle.com/Content/API/Concepts/sdkconfig.htm>`__.
-            The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config
-            the dict using :py:meth:`~oci.config.validate_config`
-
-        :param str service_endpoint: (optional)
-            The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is
-            not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit
-            need to specify a service endpoint.
-
-        :param timeout: (optional)
-            The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided
-            as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If
-            a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
-        :type timeout: float or tuple(float, float)
-
-        :param signer: (optional)
-            The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values
-            provided in the config parameter.
-
-            One use case for this parameter is for `Instance Principals authentication <https://docs.cloud.oracle.com/Content/Identity/Tasks/callingservicesfrominstances.htm>`__
-            by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument
-        :type signer: :py:class:`~oci.signer.AbstractBaseSigner`
-
-        :param obj retry_strategy: (optional)
-            A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default.
-            Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation.
-            Any value provided at the operation level will override whatever is specified at the client level.
-
-            This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY`
-            is also available. The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
-
-        :param obj circuit_breaker_strategy: (optional)
-            A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level).
-            This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided.
-            The specifics of circuit breaker strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/circuit_breakers.html>`__.
-
-        :param function circuit_breaker_callback: (optional)
-            Callback function to receive any exceptions triggerred by the circuit breaker.
-
-        :param allow_control_chars: (optional)
-            allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not
-            allow control characters to be in the response object.
-        """
-        validate_config(config, signer=kwargs.get('signer'))
-        if 'signer' in kwargs:
-            signer = kwargs['signer']
-
-        elif AUTHENTICATION_TYPE_FIELD_NAME in config:
-            signer = get_signer_from_authentication_type(config)
-
-        else:
-            signer = Signer(
-                tenancy=config["tenancy"],
-                user=config["user"],
-                fingerprint=config["fingerprint"],
-                private_key_file_location=config.get("key_file"),
-                pass_phrase=get_config_value_or_default(config, "pass_phrase"),
-                private_key_content=config.get("key_content")
-            )
-
-        base_client_init_kwargs = {
-            'regional_client': True,
-            'service_endpoint': kwargs.get('service_endpoint'),
-            'base_path': '/20211201',
-            'service_endpoint_template': 'https://fusionapps.{region}.oci.{secondLevelDomain}',
-            'skip_deserialization': kwargs.get('skip_deserialization', False),
-            'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY)
-        }
-        if 'timeout' in kwargs:
-            base_client_init_kwargs['timeout'] = kwargs.get('timeout')
-        if base_client_init_kwargs.get('circuit_breaker_strategy') is None:
-            base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY
-        if 'allow_control_chars' in kwargs:
-            base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars')
-        self.base_client = BaseClient("service_attachment", config, signer, fusion_apps_type_mapping, **base_client_init_kwargs)
-        self.retry_strategy = kwargs.get('retry_strategy')
-        self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback')
-
-    def get_service_attachment(self, fusion_environment_id, service_attachment_id, **kwargs):
-        """
-        Gets a Service Attachment by identifier
-
-
-        :param str fusion_environment_id: (required)
-            unique FusionEnvironment identifier
-
-        :param str service_attachment_id: (required)
-            OCID of the Service Attachment
-
-        :param str opc_request_id: (optional)
-            The client request ID for tracing.
-
-        :param obj retry_strategy: (optional)
-            A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
-
-            This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
-            The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
-
-            To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
-
-        :param bool allow_control_chars: (optional)
-            allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
-            By default, the response will not allow control characters in strings
-
-        :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.ServiceAttachment`
-        :rtype: :class:`~oci.response.Response`
-
-        :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.135.2/fusionapps/get_service_attachment.py.html>`__ to see an example of how to use get_service_attachment API.
-        """
-        resource_path = "/fusionEnvironments/{fusionEnvironmentId}/serviceAttachments/{serviceAttachmentId}"
-        method = "GET"
-        operation_name = "get_service_attachment"
-        api_reference_link = ""
-
-        # Don't accept unknown kwargs
-        expected_kwargs = [
-            "allow_control_chars",
-            "retry_strategy",
-            "opc_request_id"
-        ]
-        extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
-        if extra_kwargs:
-            raise ValueError(
-                "get_service_attachment got unknown kwargs: {!r}".format(extra_kwargs))
-
-        path_params = {
-            "fusionEnvironmentId": fusion_environment_id,
-            "serviceAttachmentId": service_attachment_id
-        }
-
-        path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
-
-        for (k, v) in six.iteritems(path_params):
-            if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
-                raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k))
-
-        header_params = {
-            "accept": "application/json",
-            "content-type": "application/json",
-            "opc-request-id": kwargs.get("opc_request_id", missing)
-        }
-        header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
-
-        retry_strategy = self.base_client.get_preferred_retry_strategy(
-            operation_retry_strategy=kwargs.get('retry_strategy'),
-            client_retry_strategy=self.retry_strategy
-        )
-
-        if retry_strategy:
-            if not isinstance(retry_strategy, retry.NoneRetryStrategy):
-                self.base_client.add_opc_client_retries_header(header_params)
-                retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
-            return retry_strategy.make_retrying_call(
-                self.base_client.call_api,
-                resource_path=resource_path,
-                method=method,
-                path_params=path_params,
-                header_params=header_params,
-                response_type="ServiceAttachment",
-                allow_control_chars=kwargs.get('allow_control_chars'),
-                operation_name=operation_name,
-                api_reference_link=api_reference_link)
-        else:
-            return self.base_client.call_api(
-                resource_path=resource_path,
-                method=method,
-                path_params=path_params,
-                header_params=header_params,
-                response_type="ServiceAttachment",
-                allow_control_chars=kwargs.get('allow_control_chars'),
-                operation_name=operation_name,
-                api_reference_link=api_reference_link)
-
-    def list_service_attachments(self, fusion_environment_id, **kwargs):
-        """
-        Returns a list of service attachments.
-
-
-        :param str fusion_environment_id: (required)
-            unique FusionEnvironment identifier
-
-        :param str display_name: (optional)
-            A filter to return only resources that match the entire display name given.
-
-        :param str lifecycle_state: (optional)
-            A filter that returns all resources that match the specified lifecycle state.
-
-            Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
-
-        :param str service_instance_type: (optional)
-            A filter that returns all resources that match the specified lifecycle state.
-
-            Allowed values are: "DIGITAL_ASSISTANT", "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE", "VBCS", "VISUAL_BUILDER_STUDIO"
-
-        :param int limit: (optional)
-            The maximum number of items to return.
-
-        :param str page: (optional)
-            The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
-
-        :param str sort_order: (optional)
-            The sort order to use, either 'asc' or 'desc'.
-
-            Allowed values are: "ASC", "DESC"
-
-        :param str sort_by: (optional)
-            The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
-
-            Allowed values are: "TIME_CREATED", "DISPLAY_NAME"
-
-        :param str opc_request_id: (optional)
-            The client request ID for tracing.
-
-        :param obj retry_strategy: (optional)
-            A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
-
-            This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
-            The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
-
-            To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
-
-        :param bool allow_control_chars: (optional)
-            allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
-            By default, the response will not allow control characters in strings
-
-        :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.fusion_apps.models.ServiceAttachmentCollection`
-        :rtype: :class:`~oci.response.Response`
-
-        :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.135.2/fusionapps/list_service_attachments.py.html>`__ to see an example of how to use list_service_attachments API.
-        """
-        resource_path = "/fusionEnvironments/{fusionEnvironmentId}/serviceAttachments"
-        method = "GET"
-        operation_name = "list_service_attachments"
-        api_reference_link = ""
-
-        # Don't accept unknown kwargs
-        expected_kwargs = [
-            "allow_control_chars",
-            "retry_strategy",
-            "display_name",
-            "lifecycle_state",
-            "service_instance_type",
-            "limit",
-            "page",
-            "sort_order",
-            "sort_by",
-            "opc_request_id"
-        ]
-        extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
-        if extra_kwargs:
-            raise ValueError(
-                "list_service_attachments got unknown kwargs: {!r}".format(extra_kwargs))
-
-        path_params = {
-            "fusionEnvironmentId": fusion_environment_id
-        }
-
-        path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
-
-        for (k, v) in six.iteritems(path_params):
-            if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
-                raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k))
-
-        if 'lifecycle_state' in kwargs:
-            lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"]
-            if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values:
-                raise ValueError(
-                    "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values)
-                )
-
-        if 'service_instance_type' in kwargs:
-            service_instance_type_allowed_values = ["DIGITAL_ASSISTANT", "INTEGRATION_CLOUD", "ANALYTICS_WAREHOUSE", "VBCS", "VISUAL_BUILDER_STUDIO"]
-            if kwargs['service_instance_type'] not in service_instance_type_allowed_values:
-                raise ValueError(
-                    "Invalid value for `service_instance_type`, must be one of {0}".format(service_instance_type_allowed_values)
-                )
-
-        if 'sort_order' in kwargs:
-            sort_order_allowed_values = ["ASC", "DESC"]
-            if kwargs['sort_order'] not in sort_order_allowed_values:
-                raise ValueError(
-                    "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values)
-                )
-
-        if 'sort_by' in kwargs:
-            sort_by_allowed_values = ["TIME_CREATED", "DISPLAY_NAME"]
-            if kwargs['sort_by'] not in sort_by_allowed_values:
-                raise ValueError(
-                    "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values)
-                )
-
-        query_params = {
-            "displayName": kwargs.get("display_name", missing),
-            "lifecycleState": kwargs.get("lifecycle_state", missing),
-            "serviceInstanceType": kwargs.get("service_instance_type", missing),
-            "limit": kwargs.get("limit", missing),
-            "page": kwargs.get("page", missing),
-            "sortOrder": kwargs.get("sort_order", missing),
-            "sortBy": kwargs.get("sort_by", missing)
-        }
-        query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None}
-
-        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 and v is not None}
-
-        retry_strategy = self.base_client.get_preferred_retry_strategy(
-            operation_retry_strategy=kwargs.get('retry_strategy'),
-            client_retry_strategy=self.retry_strategy
-        )
-
-        if retry_strategy:
-            if not isinstance(retry_strategy, retry.NoneRetryStrategy):
-                self.base_client.add_opc_client_retries_header(header_params)
-                retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
-            return retry_strategy.make_retrying_call(
-                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="ServiceAttachmentCollection",
-                allow_control_chars=kwargs.get('allow_control_chars'),
-                operation_name=operation_name,
-                api_reference_link=api_reference_link)
-        else:
-            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="ServiceAttachmentCollection",
-                allow_control_chars=kwargs.get('allow_control_chars'),
-                operation_name=operation_name,
-                api_reference_link=api_reference_link)

oci/fusion_apps/service_attachment_client_composite_operations.py

@@ -1,24 +0,0 @@
-# coding: utf-8
-# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
-# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
-
-import oci  # noqa: F401
-from oci.util import WAIT_RESOURCE_NOT_FOUND  # noqa: F401
-
-
-class ServiceAttachmentClientCompositeOperations(object):
-    """
-    This class provides a wrapper around :py:class:`~oci.fusion_apps.ServiceAttachmentClient` and offers convenience methods
-    for operations that would otherwise need to be chained together. For example, instead of performing an action
-    on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource
-    to enter a given state, you can call a single method in this class to accomplish the same functionality
-    """
-
-    def __init__(self, client, **kwargs):
-        """
-        Creates a new ServiceAttachmentClientCompositeOperations object
-
-        :param ServiceAttachmentClient client:
-            The service client which will be wrapped by this object
-        """
-        self.client = client