@Generated(value="OracleSDKGenerator", comments="API Version: 20190501") public final class Deployment extends Object
A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see API Gateway Concepts.
Deployment.Builder
. This model distinguishes fields
that are null
because they are unset from fields that are explicitly set to null
. This is done in
the setter methods of the Deployment.Builder
, which maintain a set of all explicitly set fields called
__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take
__explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).Modifier and Type | Class and Description |
---|---|
static class |
Deployment.Builder |
static class |
Deployment.LifecycleState
The current state of the deployment.
|
Constructor and Description |
---|
Deployment(String id,
String gatewayId,
String displayName,
String compartmentId,
String pathPrefix,
String endpoint,
ApiSpecification specification,
Date timeCreated,
Date timeUpdated,
Deployment.LifecycleState lifecycleState,
String lifecycleDetails,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static Deployment.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the compartment in which the
resource is created.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
String |
getEndpoint()
The endpoint to access this deployment on the gateway.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getGatewayId()
The OCID of the resource.
|
String |
getId()
The OCID of the resource.
|
String |
getLifecycleDetails()
A message describing the current state in more detail.
|
Deployment.LifecycleState |
getLifecycleState()
The current state of the deployment.
|
String |
getPathPrefix()
A path on which to deploy all routes contained in the API
deployment specification.
|
ApiSpecification |
getSpecification() |
Date |
getTimeCreated()
The time this resource was created.
|
Date |
getTimeUpdated()
The time this resource was last updated.
|
int |
hashCode() |
Deployment.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","gatewayId","displayName","compartmentId","pathPrefix","endpoint","specification","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags"}) @Deprecated public Deployment(String id, String gatewayId, String displayName, String compartmentId, String pathPrefix, String endpoint, ApiSpecification specification, Date timeCreated, Date timeUpdated, Deployment.LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Deployment.Builder builder()
Create a new builder.
public Deployment.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Example: `My new resource`
public String getCompartmentId()
The OCID of the compartment in which the resource is created.
public String getPathPrefix()
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.
public String getEndpoint()
The endpoint to access this deployment on the gateway.
public ApiSpecification getSpecification()
public Date getTimeCreated()
The time this resource was created. An RFC3339 formatted datetime string.
public Date getTimeUpdated()
The time this resource was last updated. An RFC3339 formatted datetime string.
public Deployment.LifecycleState getLifecycleState()
The current state of the deployment.
public String getLifecycleDetails()
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.
public Map<String,String> getFreeformTags()
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\"}`
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
Copyright © 2016–2021. All rights reserved.