ServiceEnvironment

class oci.service_manager_proxy.models.ServiceEnvironment(**kwargs)

Bases: object

Detailed information about a service environment.

Note: Service URL formats may vary from the provided example.

Attributes:

STATUS_ACCESS_DISABLED

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_ACTIVE

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_ACTIVATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_DISABLING

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_DISABLING_ACCESS

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_ENABLING

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_ENABLING_ACCESS

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_LOCK_RELOCATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_MIGRATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_RELOCATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_RESUMPTION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_SOFT_TERMINATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_SUSPENSION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_TERMINATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_BEGIN_UNLOCK_RELOCATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_CANCELED

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_DISABLED

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_FAILED_ACTIVATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_FAILED_LOCK_RELOCATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_FAILED_MIGRATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_INITIALIZED

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_LOCKED_RELOCATION

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_RELOCATED

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_SOFT_TERMINATED

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_SUSPENDED

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_TERMINATED

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_TRA_UNKNOWN

A constant which can be used with the status property of a ServiceEnvironment.

STATUS_UNLOCKED_RELOCATION

A constant which can be used with the status property of a ServiceEnvironment.

compartment_id

[Required] Gets the compartment_id of this ServiceEnvironment.

console_url

Gets the console_url of this ServiceEnvironment.

id

[Required] Gets the id of this ServiceEnvironment.

service_definition

[Required] Gets the service_definition of this ServiceEnvironment.

service_environment_endpoints

Gets the service_environment_endpoints of this ServiceEnvironment.

status

[Required] Gets the status of this ServiceEnvironment.

subscription_id

[Required] Gets the subscription_id of this ServiceEnvironment.

Methods:

__init__(**kwargs)

Initializes a new ServiceEnvironment object with values from keyword arguments.

STATUS_ACCESS_DISABLED = 'ACCESS_DISABLED'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “ACCESS_DISABLED”

STATUS_ACTIVE = 'ACTIVE'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “ACTIVE”

STATUS_BEGIN_ACTIVATION = 'BEGIN_ACTIVATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_ACTIVATION”

STATUS_BEGIN_DISABLING = 'BEGIN_DISABLING'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_DISABLING”

STATUS_BEGIN_DISABLING_ACCESS = 'BEGIN_DISABLING_ACCESS'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_DISABLING_ACCESS”

STATUS_BEGIN_ENABLING = 'BEGIN_ENABLING'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_ENABLING”

STATUS_BEGIN_ENABLING_ACCESS = 'BEGIN_ENABLING_ACCESS'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_ENABLING_ACCESS”

STATUS_BEGIN_LOCK_RELOCATION = 'BEGIN_LOCK_RELOCATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_LOCK_RELOCATION”

STATUS_BEGIN_MIGRATION = 'BEGIN_MIGRATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_MIGRATION”

STATUS_BEGIN_RELOCATION = 'BEGIN_RELOCATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_RELOCATION”

STATUS_BEGIN_RESUMPTION = 'BEGIN_RESUMPTION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_RESUMPTION”

STATUS_BEGIN_SOFT_TERMINATION = 'BEGIN_SOFT_TERMINATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_SOFT_TERMINATION”

STATUS_BEGIN_SUSPENSION = 'BEGIN_SUSPENSION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_SUSPENSION”

STATUS_BEGIN_TERMINATION = 'BEGIN_TERMINATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_TERMINATION”

STATUS_BEGIN_UNLOCK_RELOCATION = 'BEGIN_UNLOCK_RELOCATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “BEGIN_UNLOCK_RELOCATION”

STATUS_CANCELED = 'CANCELED'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “CANCELED”

STATUS_DISABLED = 'DISABLED'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “DISABLED”

STATUS_FAILED_ACTIVATION = 'FAILED_ACTIVATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “FAILED_ACTIVATION”

STATUS_FAILED_LOCK_RELOCATION = 'FAILED_LOCK_RELOCATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “FAILED_LOCK_RELOCATION”

STATUS_FAILED_MIGRATION = 'FAILED_MIGRATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “FAILED_MIGRATION”

STATUS_INITIALIZED = 'INITIALIZED'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “INITIALIZED”

STATUS_LOCKED_RELOCATION = 'LOCKED_RELOCATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “LOCKED_RELOCATION”

STATUS_RELOCATED = 'RELOCATED'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “RELOCATED”

STATUS_SOFT_TERMINATED = 'SOFT_TERMINATED'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “SOFT_TERMINATED”

STATUS_SUSPENDED = 'SUSPENDED'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “SUSPENDED”

STATUS_TERMINATED = 'TERMINATED'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “TERMINATED”

STATUS_TRA_UNKNOWN = 'TRA_UNKNOWN'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “TRA_UNKNOWN”

STATUS_UNLOCKED_RELOCATION = 'UNLOCKED_RELOCATION'

A constant which can be used with the status property of a ServiceEnvironment. This constant has a value of “UNLOCKED_RELOCATION”

__init__(**kwargs)

Initializes a new ServiceEnvironment 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 ServiceEnvironment.

  • subscription_id (str) – The value to assign to the subscription_id property of this ServiceEnvironment.

  • status (str) – The value to assign to the status property of this ServiceEnvironment. Allowed values for this property are: “INITIALIZED”, “BEGIN_ACTIVATION”, “ACTIVE”, “BEGIN_SOFT_TERMINATION”, “SOFT_TERMINATED”, “BEGIN_TERMINATION”, “CANCELED”, “TERMINATED”, “BEGIN_DISABLING”, “BEGIN_ENABLING”, “BEGIN_MIGRATION”, “DISABLED”, “BEGIN_SUSPENSION”, “BEGIN_RESUMPTION”, “SUSPENDED”, “BEGIN_LOCK_RELOCATION”, “LOCKED_RELOCATION”, “BEGIN_RELOCATION”, “RELOCATED”, “BEGIN_UNLOCK_RELOCATION”, “UNLOCKED_RELOCATION”, “FAILED_LOCK_RELOCATION”, “FAILED_ACTIVATION”, “FAILED_MIGRATION”, “ACCESS_DISABLED”, “BEGIN_DISABLING_ACCESS”, “BEGIN_ENABLING_ACCESS”, “TRA_UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • compartment_id (str) – The value to assign to the compartment_id property of this ServiceEnvironment.

  • service_definition (oci.service_manager_proxy.models.ServiceDefinition) – The value to assign to the service_definition property of this ServiceEnvironment.

  • console_url (str) – The value to assign to the console_url property of this ServiceEnvironment.

  • service_environment_endpoints (list[oci.service_manager_proxy.models.ServiceEnvironmentEndPointOverview]) – The value to assign to the service_environment_endpoints property of this ServiceEnvironment.

property compartment_id

[Required] Gets the compartment_id of this ServiceEnvironment. The OCID for the compartment.

Returns

The compartment_id of this ServiceEnvironment.

Return type

str

property console_url

Gets the console_url of this ServiceEnvironment. The URL for the console.

Returns

The console_url of this ServiceEnvironment.

Return type

str

property id

[Required] Gets the id of this ServiceEnvironment. Unqiue identifier for the entitlement related to the environment.

Note: Not an OCID.

Returns

The id of this ServiceEnvironment.

Return type

str

property service_definition

[Required] Gets the service_definition of this ServiceEnvironment.

Returns

The service_definition of this ServiceEnvironment.

Return type

oci.service_manager_proxy.models.ServiceDefinition

property service_environment_endpoints

Gets the service_environment_endpoints of this ServiceEnvironment. Array of service environment end points.

Returns

The service_environment_endpoints of this ServiceEnvironment.

Return type

list[oci.service_manager_proxy.models.ServiceEnvironmentEndPointOverview]

property status

[Required] Gets the status of this ServiceEnvironment. Status of the entitlement registration for the service.

Allowed values for this property are: “INITIALIZED”, “BEGIN_ACTIVATION”, “ACTIVE”, “BEGIN_SOFT_TERMINATION”, “SOFT_TERMINATED”, “BEGIN_TERMINATION”, “CANCELED”, “TERMINATED”, “BEGIN_DISABLING”, “BEGIN_ENABLING”, “BEGIN_MIGRATION”, “DISABLED”, “BEGIN_SUSPENSION”, “BEGIN_RESUMPTION”, “SUSPENDED”, “BEGIN_LOCK_RELOCATION”, “LOCKED_RELOCATION”, “BEGIN_RELOCATION”, “RELOCATED”, “BEGIN_UNLOCK_RELOCATION”, “UNLOCKED_RELOCATION”, “FAILED_LOCK_RELOCATION”, “FAILED_ACTIVATION”, “FAILED_MIGRATION”, “ACCESS_DISABLED”, “BEGIN_DISABLING_ACCESS”, “BEGIN_ENABLING_ACCESS”, “TRA_UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The status of this ServiceEnvironment.

Return type

str

property subscription_id

[Required] Gets the subscription_id of this ServiceEnvironment. The unique subscription ID associated with the service environment ID.

Note: Not an OCID.

Returns

The subscription_id of this ServiceEnvironment.

Return type

str