Package com.oracle.bmc.apigateway.model

Class Deployment

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.apigateway.model.Deployment

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public final class Deployment
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A deployment deploys an API on a gateway.

Avoid entering confidential information. For more information, see API Gateway Concepts.
Note: Objects should always be created or deserialized using the 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 Deployment.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Deployment.Builder
static class	Deployment.LifecycleState	The current state of the deployment.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	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.

Method Summary

Modifier and Type	Method	Description
static Deployment.Builder	builder()	Create a new builder.
boolean	equals(Object o)
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()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Deployment

@Deprecated
@ConstructorProperties({"id","gatewayId","displayName","compartmentId","pathPrefix","endpoint","specification","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags"})
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)

Deprecated.

Method Detail

builder

public static Deployment.Builder builder()

Create a new builder.

toBuilder

public Deployment.Builder toBuilder()

getId

public String getId()

The OCID of the resource.

Returns:

the value

getGatewayId

public String getGatewayId()

The OCID of the resource.

Returns:

the value

getDisplayName

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

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment in which the resource is created.

Returns:

the value

getPathPrefix

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.

Returns:

the value

getEndpoint

public String getEndpoint()

The endpoint to access this deployment on the gateway.

Returns:

the value

getSpecification

public ApiSpecification getSpecification()

getTimeCreated

public Date getTimeCreated()

The time this resource was created.

An RFC3339 formatted datetime string.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The time this resource was last updated.

An RFC3339 formatted datetime string.

Returns:

the value

getLifecycleState

public Deployment.LifecycleState getLifecycleState()

The current state of the deployment.

Returns:

the value

getLifecycleDetails

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.

Returns:

the value

getFreeformTags

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"}

Returns:

the value

getDefinedTags

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"}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel