text: #!/usr/bin/python
  # Copyright (c) 2020, 2021 Oracle and/or its affiliates.
  # This software is made available to you under the terms of the GPL 3.0 license or the Apache 2.0 license.
  # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
  # Apache License v2.0
  # See LICENSE.TXT for details.
  # GENERATED FILE - DO NOT EDIT - MANUAL CHANGES WILL BE OVERWRITTEN
  
  
  from __future__ import absolute_import, division, print_function
  
  __metaclass__ = type
  
  ANSIBLE_METADATA = {
      "metadata_version": "1.1",
      "status": ["preview"],
      "supported_by": "community",
  }
  
  DOCUMENTATION = """
  ---
  module: oci_service_catalog
  short_description: Manage a ServiceCatalog resource in Oracle Cloud Infrastructure
  description:
      - This module allows the user to create, update and delete a ServiceCatalog resource in Oracle Cloud Infrastructure
      - For I(state=present), creates a brand new service catalog in a given compartment.
      - "This resource has the following action operations in the M(oci_service_catalog_actions) module: change_compartment."
  version_added: "2.9.0"
  author: Oracle (@oracle)
  options:
      compartment_id:
          description:
              - The unique identifier for the compartment where the service catalog will be created.
              - Required for create using I(state=present).
              - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
              - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
          type: str
      display_name:
          description:
              - The display name of the service catalog.
              - Required for create using I(state=present), update using I(state=present) with service_catalog_id present.
              - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
          type: str
          aliases: ["name"]
      defined_tags:
          description:
              - "Defined tags for this resource. Each key is predefined and scoped to a namespace.
                Example: `{\\"foo-namespace\\": {\\"bar-key\\": \\"value\\"}}`"
              - This parameter is updatable.
          type: dict
      freeform_tags:
          description:
              - "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
                Example: `{\\"bar-key\\": \\"value\\"}`"
              - This parameter is updatable.
          type: dict
      service_catalog_id:
          description:
              - The unique identifier for the service catalog.
              - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set.
              - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set.
          type: str
          aliases: ["id"]
      state:
          description:
              - The state of the ServiceCatalog.
              - Use I(state=present) to create or update a ServiceCatalog.
              - Use I(state=absent) to delete a ServiceCatalog.
          type: str
          required: false
          default: 'present'
          choices: ["present", "absent"]
  extends_documentation_fragment: [ oracle.oci.oracle, oracle.oci.oracle_creatable_resource, oracle.oci.oracle_wait_options ]
  """
  
  EXAMPLES = """
  - name: Create service_catalog
    oci_service_catalog:
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
      display_name: display_name_example
  
  - name: Update service_catalog using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
    oci_service_catalog:
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
      display_name: display_name_example
      defined_tags: {'Operations': {'CostCenter': 'US'}}
      freeform_tags: {'Department': 'Finance'}
  
  - name: Update service_catalog
    oci_service_catalog:
      display_name: display_name_example
      defined_tags: {'Operations': {'CostCenter': 'US'}}
      service_catalog_id: "ocid1.servicecatalog.oc1..xxxxxxEXAMPLExxxxxx"
  
  - name: Delete service_catalog
    oci_service_catalog:
      service_catalog_id: "ocid1.servicecatalog.oc1..xxxxxxEXAMPLExxxxxx"
      state: absent
  
  - name: Delete service_catalog using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
    oci_service_catalog:
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
      display_name: display_name_example
      state: absent
  
  """
  
  RETURN = """
  service_catalog:
      description:
          - Details of the ServiceCatalog resource acted upon by the current operation
      returned: on success
      type: complex
      contains:
          id:
              description:
                  - The unique identifier for the Service catalog.
              returned: on success
              type: str
              sample: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
          compartment_id:
              description:
                  - The Compartment id where the service catalog exists
              returned: on success
              type: str
              sample: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
          display_name:
              description:
                  - The name of the service catalog.
              returned: on success
              type: str
              sample: display_name_example
          lifecycle_state:
              description:
                  - The lifecycle state of the service catalog.
              returned: on success
              type: str
              sample: ACTIVE
          time_created:
              description:
                  - The date and time the service catalog was created, expressed in L(RFC 3339,https://tools.ietf.org/html/rfc3339)
                    timestamp format.
                  - "Example: `2021-05-26T21:10:29.600Z`"
              returned: on success
              type: str
              sample: "2021-05-26T21:10:29.600Z"
          time_updated:
              description:
                  - The date and time the service catalog was last modified, expressed in L(RFC 3339,https://tools.ietf.org/html/rfc3339)
                    timestamp format.
                  - "Example: `2021-12-10T05:10:29.721Z`"
              returned: on success
              type: str
              sample: "2021-12-10T05:10:29.721Z"
          defined_tags:
              description:
                  - "Defined tags for this resource. Each key is predefined and scoped to a namespace.
                    Example: `{\\"foo-namespace\\": {\\"bar-key\\": \\"value\\"}}`"
              returned: on success
              type: dict
              sample: {'Operations': {'CostCenter': 'US'}}
          freeform_tags:
              description:
                  - "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
                    Example: `{\\"bar-key\\": \\"value\\"}`"
              returned: on success
              type: dict
              sample: {'Department': 'Finance'}
      sample: {
          "id": "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx",
          "compartment_id": "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx",
          "display_name": "display_name_example",
          "lifecycle_state": "ACTIVE",
          "time_created": "2021-05-26T21:10:29.600Z",
          "time_updated": "2021-12-10T05:10:29.721Z",
          "defined_tags": {'Operations': {'CostCenter': 'US'}},
          "freeform_tags": {'Department': 'Finance'}
      }
  """
  
  from ansible.module_utils.basic import AnsibleModule
  from ansible_collections.oracle.oci.plugins.module_utils import (
      oci_common_utils,
      oci_wait_utils,
  )
  from ansible_collections.oracle.oci.plugins.module_utils.oci_resource_utils import (
      OCIResourceHelperBase,
      get_custom_class,
  )
  
  try:
      from oci.service_catalog import ServiceCatalogClient
      from oci.service_catalog.models import CreateServiceCatalogDetails
      from oci.service_catalog.models import UpdateServiceCatalogDetails
  
      HAS_OCI_PY_SDK = True
  except ImportError:
      HAS_OCI_PY_SDK = False
  
  
  class ServiceCatalogHelperGen(OCIResourceHelperBase):
      """Supported operations: create, update, get, list and delete"""
  
      def get_module_resource_id_param(self):
          return "service_catalog_id"
  
      def get_module_resource_id(self):
          return self.module.params.get("service_catalog_id")
  
      def get_get_fn(self):
          return self.client.get_service_catalog
  
      def get_resource(self):
          return oci_common_utils.call_with_backoff(
              self.client.get_service_catalog,
              service_catalog_id=self.module.params.get("service_catalog_id"),
          )
  
      def get_required_kwargs_for_list(self):
          required_list_method_params = [
              "compartment_id",
          ]
  
          return dict(
              (param, self.module.params[param]) for param in required_list_method_params
          )
  
      def get_optional_kwargs_for_list(self):
          optional_list_method_params = ["service_catalog_id", "display_name"]
  
          return dict(
              (param, self.module.params[param])
              for param in optional_list_method_params
              if self.module.params.get(param) is not None
              and (
                  self._use_name_as_identifier()
                  or (
                      not self.module.params.get("key_by")
                      or param in self.module.params.get("key_by")
                  )
              )
          )
  
      def list_resources(self):
  
          required_kwargs = self.get_required_kwargs_for_list()
          optional_kwargs = self.get_optional_kwargs_for_list()
          kwargs = oci_common_utils.merge_dicts(required_kwargs, optional_kwargs)
          return oci_common_utils.list_all_resources(
              self.client.list_service_catalogs, **kwargs
          )
  
      def get_create_model_class(self):
          return CreateServiceCatalogDetails
  
      def create_resource(self):
          create_details = self.get_create_model()
          return oci_wait_utils.call_and_wait(
              call_fn=self.client.create_service_catalog,
              call_fn_args=(),
              call_fn_kwargs=dict(create_service_catalog_details=create_details,),
              waiter_type=oci_wait_utils.LIFECYCLE_STATE_WAITER_KEY,
              operation=oci_common_utils.CREATE_OPERATION_KEY,
              waiter_client=self.get_waiter_client(),
              resource_helper=self,
              wait_for_states=self.get_wait_for_states_for_operation(
                  oci_common_utils.CREATE_OPERATION_KEY,
              ),
          )
  
      def get_update_model_class(self):
          return UpdateServiceCatalogDetails
  
      def update_resource(self):
          update_details = self.get_update_model()
          return oci_wait_utils.call_and_wait(
              call_fn=self.client.update_service_catalog,
              call_fn_args=(),
              call_fn_kwargs=dict(
                  service_catalog_id=self.module.params.get("service_catalog_id"),
                  update_service_catalog_details=update_details,
              ),
              waiter_type=oci_wait_utils.LIFECYCLE_STATE_WAITER_KEY,
              operation=oci_common_utils.UPDATE_OPERATION_KEY,
              waiter_client=self.get_waiter_client(),
              resource_helper=self,
              wait_for_states=self.get_wait_for_states_for_operation(
                  oci_common_utils.UPDATE_OPERATION_KEY,
              ),
          )
  
      def delete_resource(self):
          return oci_wait_utils.call_and_wait(
              call_fn=self.client.delete_service_catalog,
              call_fn_args=(),
              call_fn_kwargs=dict(
                  service_catalog_id=self.module.params.get("service_catalog_id"),
              ),
              waiter_type=oci_wait_utils.LIFECYCLE_STATE_WAITER_KEY,
              operation=oci_common_utils.DELETE_OPERATION_KEY,
              waiter_client=self.get_waiter_client(),
              resource_helper=self,
              wait_for_states=self.get_wait_for_states_for_operation(
                  oci_common_utils.DELETE_OPERATION_KEY,
              ),
          )
  
  
  ServiceCatalogHelperCustom = get_custom_class("ServiceCatalogHelperCustom")
  
  
  class ResourceHelper(ServiceCatalogHelperCustom, ServiceCatalogHelperGen):
      pass
  
  
  def main():
      module_args = oci_common_utils.get_common_arg_spec(
          supports_create=True, supports_wait=True
      )
      module_args.update(
          dict(
              compartment_id=dict(type="str"),
              display_name=dict(aliases=["name"], type="str"),
              defined_tags=dict(type="dict"),
              freeform_tags=dict(type="dict"),
              service_catalog_id=dict(aliases=["id"], type="str"),
              state=dict(type="str", default="present", choices=["present", "absent"]),
          )
      )
  
      module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
  
      if not HAS_OCI_PY_SDK:
          module.fail_json(msg="oci python sdk required for this module.")
  
      resource_helper = ResourceHelper(
          module=module,
          resource_type="service_catalog",
          service_client_class=ServiceCatalogClient,
          namespace="service_catalog",
      )
  
      result = dict(changed=False)
  
      if resource_helper.is_delete_using_name():
          result = resource_helper.delete_using_name()
      elif resource_helper.is_delete():
          result = resource_helper.delete()
      elif resource_helper.is_update_using_name():
          result = resource_helper.update_using_name()
      elif resource_helper.is_update():
          result = resource_helper.update()
      elif resource_helper.is_create():
          result = resource_helper.create()
  
      module.exit_json(**result)
  
  
  if __name__ == "__main__":
      main()
  