DeploymentSummary¶

class oci.apigateway.models.DeploymentSummary(**kwargs)¶

Bases: object

A summary of the deployment.

Methods:

__init__(**kwargs)

Initializes a new DeploymentSummary object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this DeploymentSummary.
`defined_tags`	Gets the defined_tags of this DeploymentSummary.
`display_name`	Gets the display_name of this DeploymentSummary.
`endpoint`	[Required] Gets the endpoint of this DeploymentSummary.
`freeform_tags`	Gets the freeform_tags of this DeploymentSummary.
`gateway_id`	[Required] Gets the gateway_id of this DeploymentSummary.
`id`	[Required] Gets the id of this DeploymentSummary.
`lifecycle_details`	Gets the lifecycle_details of this DeploymentSummary.
`lifecycle_state`	Gets the lifecycle_state of this DeploymentSummary.
`locks`	Gets the locks of this DeploymentSummary.
`path_prefix`	[Required] Gets the path_prefix of this DeploymentSummary.
`system_tags`	Gets the system_tags of this DeploymentSummary.
`time_created`	Gets the time_created of this DeploymentSummary.
`time_updated`	Gets the time_updated of this DeploymentSummary.

__init__(**kwargs)¶

Initializes a new DeploymentSummary 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 DeploymentSummary.
gateway_id (str) – The value to assign to the gateway_id property of this DeploymentSummary.
display_name (str) – The value to assign to the display_name property of this DeploymentSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DeploymentSummary.
path_prefix (str) – The value to assign to the path_prefix property of this DeploymentSummary.
endpoint (str) – The value to assign to the endpoint property of this DeploymentSummary.
time_created (datetime) – The value to assign to the time_created property of this DeploymentSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DeploymentSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DeploymentSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DeploymentSummary.
locks (list[oci.apigateway.models.ResourceLock]) – The value to assign to the locks property of this DeploymentSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DeploymentSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DeploymentSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DeploymentSummary.

property compartment_id¶

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

Returns: The compartment_id of this DeploymentSummary.
Return type: str

property defined_tags¶

Gets the defined_tags of this DeploymentSummary. 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 DeploymentSummary.
Return type: dict(str, dict(str, object))

property display_name¶

Gets the display_name of this DeploymentSummary. 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 DeploymentSummary.
Return type: str

property endpoint¶

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

Returns: The endpoint of this DeploymentSummary.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this DeploymentSummary. 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 DeploymentSummary.
Return type: dict(str, str)

property gateway_id¶

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

Returns: The gateway_id of this DeploymentSummary.
Return type: str

property id¶

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

Returns: The id of this DeploymentSummary.
Return type: str

property lifecycle_details¶

Gets the lifecycle_details of this DeploymentSummary. 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 DeploymentSummary.
Return type: str

property lifecycle_state¶

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

Returns: The lifecycle_state of this DeploymentSummary.
Return type: str

property locks¶

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

Returns: The locks of this DeploymentSummary.
Return type: list[oci.apigateway.models.ResourceLock]

property path_prefix¶

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

Returns: The path_prefix of this DeploymentSummary.
Return type: str

property system_tags¶

Gets the system_tags of this DeploymentSummary. 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 DeploymentSummary.
Return type: dict(str, dict(str, object))

property time_created¶

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

Returns: The time_created of this DeploymentSummary.
Return type: datetime

property time_updated¶

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

Returns: The time_updated of this DeploymentSummary.
Return type: datetime