CreateDeploymentDetails

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

Bases: object

Information about a new deployment.

Methods

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

Attributes

compartment_id [Required] Gets the compartment_id of this CreateDeploymentDetails.
defined_tags Gets the defined_tags of this CreateDeploymentDetails.
display_name Gets the display_name of this CreateDeploymentDetails.
freeform_tags Gets the freeform_tags of this CreateDeploymentDetails.
gateway_id [Required] Gets the gateway_id of this CreateDeploymentDetails.
path_prefix [Required] Gets the path_prefix of this CreateDeploymentDetails.
specification Gets the specification of this CreateDeploymentDetails.
__init__(**kwargs)

Initializes a new CreateDeploymentDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • display_name (str) – The value to assign to the display_name property of this CreateDeploymentDetails.
  • gateway_id (str) – The value to assign to the gateway_id property of this CreateDeploymentDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateDeploymentDetails.
  • path_prefix (str) – The value to assign to the path_prefix property of this CreateDeploymentDetails.
  • specification (oci.apigateway.models.ApiSpecification) – The value to assign to the specification property of this CreateDeploymentDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDeploymentDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDeploymentDetails.
compartment_id

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

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

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

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

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

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

Returns:The gateway_id of this CreateDeploymentDetails.
Return type:str
path_prefix

[Required] Gets the path_prefix of this CreateDeploymentDetails. 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 CreateDeploymentDetails.
Return type:str
specification

Gets the specification of this CreateDeploymentDetails.

Returns:The specification of this CreateDeploymentDetails.
Return type:oci.apigateway.models.ApiSpecification