Deployment (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.Deployment

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Deployment
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource ( /restapis/{restapi_id}/deployments/{deployment_id}).

RestApi, Deployments, Stage, AWS CLI, AWS SDKs

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Deployment()

Constructors
Constructor and Description
`Deployment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Deployment`	`addApiSummaryEntry(String key, Map<String,MethodSnapshot> value)`
`Deployment`	`clearApiSummaryEntries()` Removes all the entries added into ApiSummary.
`Deployment`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,Map<String,MethodSnapshot>>`	`getApiSummary()` A summary of the RestApi at the date and time that the deployment resource was created.
`Date`	`getCreatedDate()` The date and time that the deployment resource was created.
`String`	`getDescription()` The description for the deployment resource.
`String`	`getId()` The identifier for the deployment resource.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApiSummary(Map<String,Map<String,MethodSnapshot>> apiSummary)` A summary of the RestApi at the date and time that the deployment resource was created.
`void`	`setCreatedDate(Date createdDate)` The date and time that the deployment resource was created.
`void`	`setDescription(String description)` The description for the deployment resource.
`void`	`setId(String id)` The identifier for the deployment resource.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Deployment`	`withApiSummary(Map<String,Map<String,MethodSnapshot>> apiSummary)` A summary of the RestApi at the date and time that the deployment resource was created.
`Deployment`	`withCreatedDate(Date createdDate)` The date and time that the deployment resource was created.
`Deployment`	`withDescription(String description)` The description for the deployment resource.
`Deployment`	`withId(String id)` The identifier for the deployment resource.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Deployment
```
public Deployment()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier for the deployment resource.
    
    Parameters:
    
    id - The identifier for the deployment resource.
  - getId
```
public String getId()
```
    The identifier for the deployment resource.
    
    Returns:
    
    The identifier for the deployment resource.
  - withId
```
public Deployment withId(String id)
```
    The identifier for the deployment resource.
    
    Parameters:
    
    id - The identifier for the deployment resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for the deployment resource.
    
    Parameters:
    
    description - The description for the deployment resource.
  - getDescription
```
public String getDescription()
```
    The description for the deployment resource.
    
    Returns:
    
    The description for the deployment resource.
  - withDescription
```
public Deployment withDescription(String description)
```
    The description for the deployment resource.
    
    Parameters:
    
    description - The description for the deployment resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The date and time that the deployment resource was created.
    
    Parameters:
    
    createdDate - The date and time that the deployment resource was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date and time that the deployment resource was created.
    
    Returns:
    
    The date and time that the deployment resource was created.
  - withCreatedDate
```
public Deployment withCreatedDate(Date createdDate)
```
    The date and time that the deployment resource was created.
    
    Parameters:
    
    createdDate - The date and time that the deployment resource was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getApiSummary
```
public Map<String,Map<String,MethodSnapshot>> getApiSummary()
```
    A summary of the RestApi at the date and time that the deployment resource was created.
    
    Returns:
    
    A summary of the RestApi at the date and time that the deployment resource was created.
  - setApiSummary
```
public void setApiSummary(Map<String,Map<String,MethodSnapshot>> apiSummary)
```
    A summary of the RestApi at the date and time that the deployment resource was created.
    
    Parameters:
    
    apiSummary - A summary of the RestApi at the date and time that the deployment resource was created.
  - withApiSummary
```
public Deployment withApiSummary(Map<String,Map<String,MethodSnapshot>> apiSummary)
```
    A summary of the RestApi at the date and time that the deployment resource was created.
    
    Parameters:
    
    apiSummary - A summary of the RestApi at the date and time that the deployment resource was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addApiSummaryEntry
```
public Deployment addApiSummaryEntry(String key,
                                     Map<String,MethodSnapshot> value)
```
  - clearApiSummaryEntries
```
public Deployment clearApiSummaryEntries()
```
    Removes all the entries added into ApiSummary.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Deployment clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Deployment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Deployment

Method Detail

setId

getId

withId

setDescription

getDescription

withDescription

setCreatedDate

getCreatedDate

withCreatedDate

getApiSummary

setApiSummary

withApiSummary

addApiSummaryEntry

clearApiSummaryEntries

toString

equals

hashCode

clone

marshall