ServiceSummary

class oci.cloud_guard.models.ServiceSummary(**kwargs)

Bases: object

A SaaS service which exists in the tenancy.

Methods

__init__(**kwargs) Initializes a new ServiceSummary object with values from keyword arguments.

Attributes

compartment_id [Required] Gets the compartment_id of this ServiceSummary.
defined_tags Gets the defined_tags of this ServiceSummary.
display_name [Required] Gets the display_name of this ServiceSummary.
freeform_tags Gets the freeform_tags of this ServiceSummary.
id [Required] Gets the id of this ServiceSummary.
region Gets the region of this ServiceSummary.
saas_service_name [Required] Gets the saas_service_name of this ServiceSummary.
service_overview_path Gets the service_overview_path of this ServiceSummary.
system_tags Gets the system_tags of this ServiceSummary.
__init__(**kwargs)

Initializes a new ServiceSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • id (str) – The value to assign to the id property of this ServiceSummary.
  • display_name (str) – The value to assign to the display_name property of this ServiceSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this ServiceSummary.
  • saas_service_name (str) – The value to assign to the saas_service_name property of this ServiceSummary.
  • service_overview_path (str) – The value to assign to the service_overview_path property of this ServiceSummary.
  • region (str) – The value to assign to the region property of this ServiceSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ServiceSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ServiceSummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ServiceSummary.
compartment_id

[Required] Gets the compartment_id of this ServiceSummary. OCID of the compartment. Always a tenancy OCID

Returns:The compartment_id of this ServiceSummary.
Return type:str
defined_tags

Gets the defined_tags of this ServiceSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this ServiceSummary.
Return type:dict(str, dict(str, object))
display_name

[Required] Gets the display_name of this ServiceSummary. The Value to be displayed on the One Console

Returns:The display_name of this ServiceSummary.
Return type:str
freeform_tags

Gets the freeform_tags of this ServiceSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Avoid entering confidential information.

Returns:The freeform_tags of this ServiceSummary.
Return type:dict(str, str)
id

[Required] Gets the id of this ServiceSummary. The ocid of the service.

Returns:The id of this ServiceSummary.
Return type:str
region

Gets the region of this ServiceSummary. The region in which the service exists

Returns:The region of this ServiceSummary.
Return type:str
saas_service_name

[Required] Gets the saas_service_name of this ServiceSummary. The service name of the service. This value is fetched from Tenant-Manager which syncs with TAS

Returns:The saas_service_name of this ServiceSummary.
Return type:str
service_overview_path

Gets the service_overview_path of this ServiceSummary. The service overview path of the service. This value is used to perform navigation to the service overview page.

Returns:The service_overview_path of this ServiceSummary.
Return type:str
system_tags

Gets the system_tags of this ServiceSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:The system_tags of this ServiceSummary.
Return type:dict(str, dict(str, object))