Deployment

class oci.apigateway.models.Deployment(**kwargs)

Bases: object

A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see API Gateway Concepts.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Deployment.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Deployment.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Deployment.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Deployment.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Deployment.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Deployment.

compartment_id

[Required] Gets the compartment_id of this Deployment.

defined_tags

Gets the defined_tags of this Deployment.

display_name

Gets the display_name of this Deployment.

endpoint

[Required] Gets the endpoint of this Deployment.

freeform_tags

Gets the freeform_tags of this Deployment.

gateway_id

[Required] Gets the gateway_id of this Deployment.

id

[Required] Gets the id of this Deployment.

lifecycle_details

Gets the lifecycle_details of this Deployment.

lifecycle_state

Gets the lifecycle_state of this Deployment.

locks

Gets the locks of this Deployment.

path_prefix

[Required] Gets the path_prefix of this Deployment.

specification

[Required] Gets the specification of this Deployment.

system_tags

Gets the system_tags of this Deployment.

time_created

Gets the time_created of this Deployment.

time_updated

Gets the time_updated of this Deployment.

Methods:

__init__(**kwargs)

Initializes a new Deployment object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “UPDATING”

__init__(**kwargs)

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

  • gateway_id (str) – The value to assign to the gateway_id property of this Deployment.

  • display_name (str) – The value to assign to the display_name property of this Deployment.

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

  • path_prefix (str) – The value to assign to the path_prefix property of this Deployment.

  • endpoint (str) – The value to assign to the endpoint property of this Deployment.

  • specification (oci.apigateway.models.ApiSpecification) – The value to assign to the specification property of this Deployment.

  • time_created (datetime) – The value to assign to the time_created property of this Deployment.

  • time_updated (datetime) – The value to assign to the time_updated property of this Deployment.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Deployment. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Deployment.

  • locks (list[oci.apigateway.models.ResourceLock]) – The value to assign to the locks property of this Deployment.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Deployment.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Deployment.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Deployment.

property compartment_id

[Required] Gets the compartment_id of this Deployment. The OCID of the compartment in which the resource is created.

Returns

The compartment_id of this Deployment.

Return type

str

property defined_tags

Gets the defined_tags of this Deployment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this Deployment.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this Deployment. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Example: My new resource

Returns

The display_name of this Deployment.

Return type

str

property endpoint

[Required] Gets the endpoint of this Deployment. The endpoint to access this deployment on the gateway.

Returns

The endpoint of this Deployment.

Return type

str

property freeform_tags

Gets the freeform_tags of this Deployment. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this Deployment.

Return type

dict(str, str)

property gateway_id

[Required] Gets the gateway_id of this Deployment. The OCID of the resource.

Returns

The gateway_id of this Deployment.

Return type

str

property id

[Required] Gets the id of this Deployment. The OCID of the resource.

Returns

The id of this Deployment.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Deployment. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

Returns

The lifecycle_details of this Deployment.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this Deployment. The current state of the deployment.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Deployment.

Return type

str

property locks

Gets the locks of this Deployment. Locks associated with this resource.

Returns

The locks of this Deployment.

Return type

list[oci.apigateway.models.ResourceLock]

property path_prefix

[Required] Gets the path_prefix of this Deployment. A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.

Returns

The path_prefix of this Deployment.

Return type

str

property specification

[Required] Gets the specification of this Deployment.

Returns

The specification of this Deployment.

Return type

oci.apigateway.models.ApiSpecification

property system_tags

Gets the system_tags of this Deployment. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this Deployment.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this Deployment. The time this resource was created. An RFC3339 formatted datetime string.

Returns

The time_created of this Deployment.

Return type

datetime

property time_updated

Gets the time_updated of this Deployment. The time this resource was last updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this Deployment.

Return type

datetime