GatewaySummary

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

Bases: object

A summary of the gateway.

Methods

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

Attributes

certificate_id Gets the certificate_id of this GatewaySummary.
compartment_id [Required] Gets the compartment_id of this GatewaySummary.
defined_tags Gets the defined_tags of this GatewaySummary.
display_name Gets the display_name of this GatewaySummary.
endpoint_type [Required] Gets the endpoint_type of this GatewaySummary.
freeform_tags Gets the freeform_tags of this GatewaySummary.
hostname Gets the hostname of this GatewaySummary.
id [Required] Gets the id of this GatewaySummary.
lifecycle_details Gets the lifecycle_details of this GatewaySummary.
lifecycle_state Gets the lifecycle_state of this GatewaySummary.
subnet_id Gets the subnet_id of this GatewaySummary.
time_created Gets the time_created of this GatewaySummary.
time_updated Gets the time_updated of this GatewaySummary.
__init__(**kwargs)

Initializes a new GatewaySummary 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 GatewaySummary.
  • display_name (str) – The value to assign to the display_name property of this GatewaySummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this GatewaySummary.
  • endpoint_type (str) – The value to assign to the endpoint_type property of this GatewaySummary.
  • subnet_id (str) – The value to assign to the subnet_id property of this GatewaySummary.
  • time_created (datetime) – The value to assign to the time_created property of this GatewaySummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this GatewaySummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this GatewaySummary.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this GatewaySummary.
  • hostname (str) – The value to assign to the hostname property of this GatewaySummary.
  • certificate_id (str) – The value to assign to the certificate_id property of this GatewaySummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this GatewaySummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this GatewaySummary.
certificate_id

Gets the certificate_id of this GatewaySummary. The OCID of the resource.

Returns:The certificate_id of this GatewaySummary.
Return type:str
compartment_id

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

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

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

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

[Required] Gets the endpoint_type of this GatewaySummary. Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet.

Example: PUBLIC or PRIVATE

Returns:The endpoint_type of this GatewaySummary.
Return type:str
freeform_tags

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

Gets the hostname of this GatewaySummary. The hostname for the APIs deployed on the gateway.

Returns:The hostname of this GatewaySummary.
Return type:str
id

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

Returns:The id of this GatewaySummary.
Return type:str
lifecycle_details

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

Gets the lifecycle_state of this GatewaySummary. The current state of the gateway.

Returns:The lifecycle_state of this GatewaySummary.
Return type:str
subnet_id

Gets the subnet_id of this GatewaySummary. The OCID of the subnet in which related resources are created.

Returns:The subnet_id of this GatewaySummary.
Return type:str
time_created

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

Returns:The time_created of this GatewaySummary.
Return type:datetime
time_updated

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

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