BaseService¶
- class oci.announcements_service.models.BaseService(**kwargs)¶
Bases:
objectObject representing a single service.
Attributes:
A constant which can be used with the comms_manager_name property of a BaseService.
A constant which can be used with the comms_manager_name property of a BaseService.
A constant which can be used with the comms_manager_name property of a BaseService.
A constant which can be used with the comms_manager_name property of a BaseService.
A constant which can be used with the lifecycle_state property of a BaseService.
A constant which can be used with the lifecycle_state property of a BaseService.
A constant which can be used with the platform_type property of a BaseService.
A constant which can be used with the platform_type property of a BaseService.
A constant which can be used with the platform_type property of a BaseService.
[Required] Gets the comms_manager_name of this BaseService.
[Required] Gets the excluded_realms of this BaseService.
[Required] Gets the id of this BaseService.
Gets the lifecycle_state of this BaseService.
[Required] Gets the platform_type of this BaseService.
[Required] Gets the previous_service_names of this BaseService.
[Required] Gets the service_name of this BaseService.
[Required] Gets the short_name of this BaseService.
[Required] Gets the team_name of this BaseService.
Gets the time_created of this BaseService.
Gets the time_updated of this BaseService.
[Required] Gets the type of this BaseService.
Methods:
__init__(**kwargs)Initializes a new BaseService object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- COMMS_MANAGER_NAME_AS = 'AS'¶
A constant which can be used with the comms_manager_name property of a BaseService. This constant has a value of “AS”
- COMMS_MANAGER_NAME_CN = 'CN'¶
A constant which can be used with the comms_manager_name property of a BaseService. This constant has a value of “CN”
- COMMS_MANAGER_NAME_ERF = 'ERF'¶
A constant which can be used with the comms_manager_name property of a BaseService. This constant has a value of “ERF”
- COMMS_MANAGER_NAME_FUSION = 'FUSION'¶
A constant which can be used with the comms_manager_name property of a BaseService. This constant has a value of “FUSION”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a BaseService. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a BaseService. This constant has a value of “DELETED”
- PLATFORM_TYPE_IAAS = 'IAAS'¶
A constant which can be used with the platform_type property of a BaseService. This constant has a value of “IAAS”
- PLATFORM_TYPE_PAAS = 'PAAS'¶
A constant which can be used with the platform_type property of a BaseService. This constant has a value of “PAAS”
- PLATFORM_TYPE_SAAS = 'SAAS'¶
A constant which can be used with the platform_type property of a BaseService. This constant has a value of “SAAS”
- __init__(**kwargs)¶
Initializes a new BaseService object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
type (str) – The value to assign to the type property of this BaseService.
id (str) – The value to assign to the id property of this BaseService.
service_name (str) – The value to assign to the service_name property of this BaseService.
short_name (str) – The value to assign to the short_name property of this BaseService.
team_name (str) – The value to assign to the team_name property of this BaseService.
platform_type (str) – The value to assign to the platform_type property of this BaseService. Allowed values for this property are: “IAAS”, “SAAS”, “PAAS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
comms_manager_name (str) – The value to assign to the comms_manager_name property of this BaseService. Allowed values for this property are: “CN”, “FUSION”, “AS”, “ERF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
excluded_realms (list[str]) – The value to assign to the excluded_realms property of this BaseService.
previous_service_names (list[str]) – The value to assign to the previous_service_names property of this BaseService.
time_created (datetime) – The value to assign to the time_created property of this BaseService.
time_updated (datetime) – The value to assign to the time_updated property of this BaseService.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BaseService. Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property comms_manager_name¶
[Required] Gets the comms_manager_name of this BaseService. Name of the comms manager team that manages Notifications to this service.
Allowed values for this property are: “CN”, “FUSION”, “AS”, “ERF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The comms_manager_name of this BaseService.
- Return type
str
- property excluded_realms¶
[Required] Gets the excluded_realms of this BaseService. The list of realms where this service is not available to be used.
- Returns
The excluded_realms of this BaseService.
- Return type
list[str]
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property id¶
[Required] Gets the id of this BaseService. ID of the service object.
- Returns
The id of this BaseService.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this BaseService. Current state of the service object.
Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this BaseService.
- Return type
str
- property platform_type¶
[Required] Gets the platform_type of this BaseService. The platform type this service object is related to.
Allowed values for this property are: “IAAS”, “SAAS”, “PAAS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The platform_type of this BaseService.
- Return type
str
- property previous_service_names¶
[Required] Gets the previous_service_names of this BaseService. The list of previously used names for this service object.
- Returns
The previous_service_names of this BaseService.
- Return type
list[str]
- property service_name¶
[Required] Gets the service_name of this BaseService. Name of the service represented by this object.
- Returns
The service_name of this BaseService.
- Return type
str
- property short_name¶
[Required] Gets the short_name of this BaseService. Short name of the team to whom this service object is related.
- Returns
The short_name of this BaseService.
- Return type
str
- property team_name¶
[Required] Gets the team_name of this BaseService. Team name to which this service object is related.
- Returns
The team_name of this BaseService.
- Return type
str
- property time_created¶
Gets the time_created of this BaseService. The date and time when the service object was created.
- Returns
The time_created of this BaseService.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this BaseService. The date and time when the service object was updated.
- Returns
The time_updated of this BaseService.
- Return type
datetime
- property type¶
[Required] Gets the type of this BaseService. The discriminator property.
- Returns
The type of this BaseService.
- Return type
str