ListTypesRequest (AWS Java SDK for AWS CloudFormation 1.12.728 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cloudformation.model.ListTypesRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListTypesRequest
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

ListTypesRequest()

Constructors
Constructor and Description
`ListTypesRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListTypesRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDeprecatedStatus()` The deprecation status of the extension that you want to get summary information about.
`TypeFilters`	`getFilters()` Filter criteria to use in determining which extensions to return.
`Integer`	`getMaxResults()` The maximum number of results to be returned with a single call.
`String`	`getNextToken()` If the previous paginated request didn't return all the remaining results, the response object's `NextToken` parameter value is set to a token.
`String`	`getProvisioningType()` For resource types, the provisioning behavior of the resource type.
`String`	`getType()` The type of extension.
`String`	`getVisibility()` The scope at which the extensions are visible and usable in CloudFormation operations.
`int`	`hashCode()`
`void`	`setDeprecatedStatus(String deprecatedStatus)` The deprecation status of the extension that you want to get summary information about.
`void`	`setFilters(TypeFilters filters)` Filter criteria to use in determining which extensions to return.
`void`	`setMaxResults(Integer maxResults)` The maximum number of results to be returned with a single call.
`void`	`setNextToken(String nextToken)` If the previous paginated request didn't return all the remaining results, the response object's `NextToken` parameter value is set to a token.
`void`	`setProvisioningType(String provisioningType)` For resource types, the provisioning behavior of the resource type.
`void`	`setType(String type)` The type of extension.
`void`	`setVisibility(String visibility)` The scope at which the extensions are visible and usable in CloudFormation operations.
`String`	`toString()` Returns a string representation of this object.
`ListTypesRequest`	`withDeprecatedStatus(DeprecatedStatus deprecatedStatus)` The deprecation status of the extension that you want to get summary information about.
`ListTypesRequest`	`withDeprecatedStatus(String deprecatedStatus)` The deprecation status of the extension that you want to get summary information about.
`ListTypesRequest`	`withFilters(TypeFilters filters)` Filter criteria to use in determining which extensions to return.
`ListTypesRequest`	`withMaxResults(Integer maxResults)` The maximum number of results to be returned with a single call.
`ListTypesRequest`	`withNextToken(String nextToken)` If the previous paginated request didn't return all the remaining results, the response object's `NextToken` parameter value is set to a token.
`ListTypesRequest`	`withProvisioningType(ProvisioningType provisioningType)` For resource types, the provisioning behavior of the resource type.
`ListTypesRequest`	`withProvisioningType(String provisioningType)` For resource types, the provisioning behavior of the resource type.
`ListTypesRequest`	`withType(RegistryType type)` The type of extension.
`ListTypesRequest`	`withType(String type)` The type of extension.
`ListTypesRequest`	`withVisibility(String visibility)` The scope at which the extensions are visible and usable in CloudFormation operations.
`ListTypesRequest`	`withVisibility(Visibility visibility)` The scope at which the extensions are visible and usable in CloudFormation operations.

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

- Constructor Detail
  - ListTypesRequest
```
public ListTypesRequest()
```
- Method Detail
  - setVisibility
```
public void setVisibility(String visibility)
```
    The scope at which the extensions are visible and usable in CloudFormation operations.
    
    Valid values include:
    - PRIVATE: Extensions that are visible and usable within this account and Region. This includes:
      
      Private extensions you have registered in this account and Region.
      
      Public extensions that you have activated in this account and Region.
    - PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
    The default is PRIVATE.
    Parameters:
    visibility - The scope at which the extensions are visible and usable in CloudFormation operations.
    
    Valid values include:
    
    PRIVATE: Extensions that are visible and usable within this account and Region. This includes:
    
    Private extensions you have registered in this account and Region.
    
    Public extensions that you have activated in this account and Region.
    
    PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
    
    The default is PRIVATE.
    See Also:
    
    Visibility
  - getVisibility
```
public String getVisibility()
```
    The scope at which the extensions are visible and usable in CloudFormation operations.
    
    Valid values include:
    - PRIVATE: Extensions that are visible and usable within this account and Region. This includes:
      
      Private extensions you have registered in this account and Region.
      
      Public extensions that you have activated in this account and Region.
    - PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
    The default is PRIVATE.
    Returns:
    The scope at which the extensions are visible and usable in CloudFormation operations.
    
    Valid values include:
    
    PRIVATE: Extensions that are visible and usable within this account and Region. This includes:
    
    Private extensions you have registered in this account and Region.
    
    Public extensions that you have activated in this account and Region.
    
    PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
    
    The default is PRIVATE.
    See Also:
    
    Visibility
  - withVisibility
```
public ListTypesRequest withVisibility(String visibility)
```
    The scope at which the extensions are visible and usable in CloudFormation operations.
    
    Valid values include:
    - PRIVATE: Extensions that are visible and usable within this account and Region. This includes:
      
      Private extensions you have registered in this account and Region.
      
      Public extensions that you have activated in this account and Region.
    - PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
    The default is PRIVATE.
    Parameters:
    visibility - The scope at which the extensions are visible and usable in CloudFormation operations.
    
    Valid values include:
    
    PRIVATE: Extensions that are visible and usable within this account and Region. This includes:
    
    Private extensions you have registered in this account and Region.
    
    Public extensions that you have activated in this account and Region.
    
    PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
    
    The default is PRIVATE.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - withVisibility
```
public ListTypesRequest withVisibility(Visibility visibility)
```
    The scope at which the extensions are visible and usable in CloudFormation operations.
    
    Valid values include:
    - PRIVATE: Extensions that are visible and usable within this account and Region. This includes:
      
      Private extensions you have registered in this account and Region.
      
      Public extensions that you have activated in this account and Region.
    - PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
    The default is PRIVATE.
    Parameters:
    visibility - The scope at which the extensions are visible and usable in CloudFormation operations.
    
    Valid values include:
    
    PRIVATE: Extensions that are visible and usable within this account and Region. This includes:
    
    Private extensions you have registered in this account and Region.
    
    Public extensions that you have activated in this account and Region.
    
    PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
    
    The default is PRIVATE.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - setProvisioningType
```
public void setProvisioningType(String provisioningType)
```
    For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
    
    Valid values include:
    - FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    - IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    - NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
    The default is FULLY_MUTABLE.
    Parameters:
    provisioningType - For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
    
    Valid values include:
    
    FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    
    IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    
    NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
    
    The default is FULLY_MUTABLE.
    See Also:
    
    ProvisioningType
  - getProvisioningType
```
public String getProvisioningType()
```
    For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
    
    Valid values include:
    - FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    - IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    - NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
    The default is FULLY_MUTABLE.
    Returns:
    For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
    
    Valid values include:
    
    FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    
    IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    
    NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
    
    The default is FULLY_MUTABLE.
    See Also:
    
    ProvisioningType
  - withProvisioningType
```
public ListTypesRequest withProvisioningType(String provisioningType)
```
    For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
    
    Valid values include:
    - FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    - IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    - NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
    The default is FULLY_MUTABLE.
    Parameters:
    provisioningType - For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
    
    Valid values include:
    
    FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    
    IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    
    NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
    
    The default is FULLY_MUTABLE.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProvisioningType
  - withProvisioningType
```
public ListTypesRequest withProvisioningType(ProvisioningType provisioningType)
```
    For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
    
    Valid values include:
    - FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    - IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    - NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
    The default is FULLY_MUTABLE.
    Parameters:
    provisioningType - For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
    
    Valid values include:
    
    FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    
    IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    
    NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
    
    The default is FULLY_MUTABLE.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProvisioningType
  - setDeprecatedStatus
```
public void setDeprecatedStatus(String deprecatedStatus)
```
    The deprecation status of the extension that you want to get summary information about.
    
    Valid values include:
    - LIVE: The extension is registered for use in CloudFormation operations.
    - DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    Parameters:
    deprecatedStatus - The deprecation status of the extension that you want to get summary information about.
    
    Valid values include:
    
    LIVE: The extension is registered for use in CloudFormation operations.
    
    DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    See Also:
    
    DeprecatedStatus
  - getDeprecatedStatus
```
public String getDeprecatedStatus()
```
    The deprecation status of the extension that you want to get summary information about.
    
    Valid values include:
    - LIVE: The extension is registered for use in CloudFormation operations.
    - DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    Returns:
    The deprecation status of the extension that you want to get summary information about.
    
    Valid values include:
    
    LIVE: The extension is registered for use in CloudFormation operations.
    
    DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    See Also:
    
    DeprecatedStatus
  - withDeprecatedStatus
```
public ListTypesRequest withDeprecatedStatus(String deprecatedStatus)
```
    The deprecation status of the extension that you want to get summary information about.
    
    Valid values include:
    - LIVE: The extension is registered for use in CloudFormation operations.
    - DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    Parameters:
    deprecatedStatus - The deprecation status of the extension that you want to get summary information about.
    
    Valid values include:
    
    LIVE: The extension is registered for use in CloudFormation operations.
    
    DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeprecatedStatus
  - withDeprecatedStatus
```
public ListTypesRequest withDeprecatedStatus(DeprecatedStatus deprecatedStatus)
```
    The deprecation status of the extension that you want to get summary information about.
    
    Valid values include:
    - LIVE: The extension is registered for use in CloudFormation operations.
    - DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    Parameters:
    deprecatedStatus - The deprecation status of the extension that you want to get summary information about.
    
    Valid values include:
    
    LIVE: The extension is registered for use in CloudFormation operations.
    
    DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeprecatedStatus
  - setType
```
public void setType(String type)
```
    The type of extension.
    
    Parameters:
    
    type - The type of extension.
    
    See Also:
    
    RegistryType
  - getType
```
public String getType()
```
    The type of extension.
    
    Returns:
    
    The type of extension.
    
    See Also:
    
    RegistryType
  - withType
```
public ListTypesRequest withType(String type)
```
    The type of extension.
    
    Parameters:
    
    type - The type of extension.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RegistryType
  - withType
```
public ListTypesRequest withType(RegistryType type)
```
    The type of extension.
    
    Parameters:
    
    type - The type of extension.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RegistryType
  - setFilters
```
public void setFilters(TypeFilters filters)
```
    Filter criteria to use in determining which extensions to return.
    
    Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.
    
    Parameters:
    
    filters - Filter criteria to use in determining which extensions to return.
    
    Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.
  - getFilters
```
public TypeFilters getFilters()
```
    Filter criteria to use in determining which extensions to return.
    
    Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.
    
    Returns:
    
    Filter criteria to use in determining which extensions to return.
    
    Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.
  - withFilters
```
public ListTypesRequest withFilters(TypeFilters filters)
```
    Filter criteria to use in determining which extensions to return.
    
    Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.
    
    Parameters:
    
    filters - Filter criteria to use in determining which extensions to return.
    
    Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
    
    Parameters:
    
    maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
    
    Returns:
    
    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
  - withMaxResults
```
public ListTypesRequest withMaxResults(Integer maxResults)
```
    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
    
    Parameters:
    
    maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter 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)
```
    If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
    
    Parameters:
    
    nextToken - If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
  - getNextToken
```
public String getNextToken()
```
    If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
    
    Returns:
    
    If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
  - withNextToken
```
public ListTypesRequest withNextToken(String nextToken)
```
    If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
    
    Parameters:
    
    nextToken - If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
    
    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 ListTypesRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class ListTypesRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListTypesRequest

Method Detail

setVisibility

getVisibility

withVisibility

withVisibility

setProvisioningType

getProvisioningType

withProvisioningType

withProvisioningType

setDeprecatedStatus

getDeprecatedStatus

withDeprecatedStatus

withDeprecatedStatus

setType

getType

withType

withType

setFilters

getFilters

withFilters

setMaxResults

getMaxResults

withMaxResults

setNextToken

getNextToken

withNextToken

toString

equals

hashCode

clone