com.amazonaws.services.opsworks.model

Class DescribeAppsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.DescribeAppsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeAppsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeApps operation.

Requests a description of a specified set of apps.

NOTE: You must specify at least one of the parameters.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

See Also:

AWSOpsWorks.describeApps(DescribeAppsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAppsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeAppsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getAppIds() An array of app IDs for the apps to be described.
String	getStackId() The app stack ID.
int	hashCode()
void	setAppIds(Collection<String> appIds) An array of app IDs for the apps to be described.
void	setStackId(String stackId) The app stack ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeAppsRequest	withAppIds(Collection<String> appIds) An array of app IDs for the apps to be described.
DescribeAppsRequest	withAppIds(String... appIds) An array of app IDs for the apps to be described.
DescribeAppsRequest	withStackId(String stackId) The app stack ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeAppsRequest

public DescribeAppsRequest()

Method Detail

getStackId

public String getStackId()

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

Returns:

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

setStackId

public void setStackId(String stackId)

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

Parameters:

stackId - The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

withStackId

public DescribeAppsRequest withStackId(String stackId)

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:

stackId - The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

Returns:

A reference to this updated object so that method calls can be chained together.

getAppIds

public List<String> getAppIds()

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

Returns:

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

setAppIds

public void setAppIds(Collection<String> appIds)

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

Parameters:

appIds - An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

withAppIds

public DescribeAppsRequest withAppIds(String... appIds)

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

NOTE: This method appends the values to the existing list (if any). Use setAppIds(java.util.Collection) or withAppIds(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

appIds - An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

Returns:

A reference to this updated object so that method calls can be chained together.

withAppIds

public DescribeAppsRequest withAppIds(Collection<String> appIds)

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

Returns a reference to this object so that method calls can be chained together.

Parameters:

appIds - An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeAppsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()