com.amazonaws.services.simplesystemsmanagement.model

Class GetParametersByPathRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.GetParametersByPathRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetParametersByPathRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetParametersByPathRequest()

Method Summary

Modifier and Type	Method and Description
GetParametersByPathRequest	clone()
boolean	equals(Object obj)
Integer	getMaxResults() The maximum number of items to return for this call.
String	getNextToken() A token to start the list.
List<ParameterStringFilter>	getParameterFilters() Filters to limit the request results.
String	getPath() The hierarchy for the parameter.
Boolean	getRecursive() Retrieve all parameters within a hierarchy.
Boolean	getWithDecryption() Retrieve all parameters in a hierarchy with their value decrypted.
int	hashCode()
Boolean	isRecursive() Retrieve all parameters within a hierarchy.
Boolean	isWithDecryption() Retrieve all parameters in a hierarchy with their value decrypted.
void	setMaxResults(Integer maxResults) The maximum number of items to return for this call.
void	setNextToken(String nextToken) A token to start the list.
void	setParameterFilters(Collection<ParameterStringFilter> parameterFilters) Filters to limit the request results.
void	setPath(String path) The hierarchy for the parameter.
void	setRecursive(Boolean recursive) Retrieve all parameters within a hierarchy.
void	setWithDecryption(Boolean withDecryption) Retrieve all parameters in a hierarchy with their value decrypted.
String	toString() Returns a string representation of this object.
GetParametersByPathRequest	withMaxResults(Integer maxResults) The maximum number of items to return for this call.
GetParametersByPathRequest	withNextToken(String nextToken) A token to start the list.
GetParametersByPathRequest	withParameterFilters(Collection<ParameterStringFilter> parameterFilters) Filters to limit the request results.
GetParametersByPathRequest	withParameterFilters(ParameterStringFilter... parameterFilters) Filters to limit the request results.
GetParametersByPathRequest	withPath(String path) The hierarchy for the parameter.
GetParametersByPathRequest	withRecursive(Boolean recursive) Retrieve all parameters within a hierarchy.
GetParametersByPathRequest	withWithDecryption(Boolean withDecryption) Retrieve all parameters in a hierarchy with their value decrypted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

GetParametersByPathRequest

public GetParametersByPathRequest()

Method Detail

setPath

public void setPath(String path)

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Parameters:

path - The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

getPath

public String getPath()

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Returns:

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

withPath

public GetParametersByPathRequest withPath(String path)

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Parameters:

path - The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Returns:

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

setRecursive

public void setRecursive(Boolean recursive)

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

Parameters:

recursive - Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

getRecursive

public Boolean getRecursive()

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

Returns:

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

withRecursive

public GetParametersByPathRequest withRecursive(Boolean recursive)

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

Parameters:

recursive - Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

Returns:

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

isRecursive

public Boolean isRecursive()

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

Returns:

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

getParameterFilters

public List<ParameterStringFilter> getParameterFilters()

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

Returns:

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

setParameterFilters

public void setParameterFilters(Collection<ParameterStringFilter> parameterFilters)

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

Parameters:

parameterFilters - Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

withParameterFilters

public GetParametersByPathRequest withParameterFilters(ParameterStringFilter... parameterFilters)

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

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

Parameters:

parameterFilters - Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

Returns:

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

withParameterFilters

public GetParametersByPathRequest withParameterFilters(Collection<ParameterStringFilter> parameterFilters)

Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

Parameters:

parameterFilters - Filters to limit the request results.

The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

Returns:

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

setWithDecryption

public void setWithDecryption(Boolean withDecryption)

Retrieve all parameters in a hierarchy with their value decrypted.

Parameters:

withDecryption - Retrieve all parameters in a hierarchy with their value decrypted.

getWithDecryption

public Boolean getWithDecryption()

Retrieve all parameters in a hierarchy with their value decrypted.

Returns:

Retrieve all parameters in a hierarchy with their value decrypted.

withWithDecryption

public GetParametersByPathRequest withWithDecryption(Boolean withDecryption)

Retrieve all parameters in a hierarchy with their value decrypted.

Parameters:

withDecryption - Retrieve all parameters in a hierarchy with their value decrypted.

Returns:

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

isWithDecryption

public Boolean isWithDecryption()

Retrieve all parameters in a hierarchy with their value decrypted.

Returns:

Retrieve all parameters in a hierarchy with their value decrypted.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameters:

maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

getMaxResults

public Integer getMaxResults()

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

withMaxResults

public GetParametersByPathRequest withMaxResults(Integer maxResults)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameters:

maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

A token to start the list. Use this token to get the next set of results.

Parameters:

nextToken - A token to start the list. Use this token to get the next set of results.

getNextToken

public String getNextToken()

A token to start the list. Use this token to get the next set of results.

Returns:

A token to start the list. Use this token to get the next set of results.

withNextToken

public GetParametersByPathRequest withNextToken(String nextToken)

A token to start the list. Use this token to get the next set of results.

Parameters:

nextToken - A token to start the list. Use this token to get the next set of results.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 GetParametersByPathRequest clone()

Overrides:

clone in class AmazonWebServiceRequest