Class ListTypesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
-
- software.amazon.awssdk.services.cloudformation.model.ListTypesRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListTypesRequest.Builder,ListTypesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListTypesRequest extends CloudFormationRequest implements ToCopyableBuilder<ListTypesRequest.Builder,ListTypesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ListTypesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListTypesRequest.Builder
builder()
DeprecatedStatus
deprecatedStatus()
The deprecation status of the extension that you want to get summary information about.String
deprecatedStatusAsString()
The deprecation status of the extension that you want to get summary information about.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
TypeFilters
filters()
Filter criteria to use in determining which extensions to return.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Integer
maxResults()
The maximum number of results to be returned with a single call.String
nextToken()
If the previous paginated request didn't return all the remaining results, the response object'sNextToken
parameter value is set to a token.ProvisioningType
provisioningType()
For resource types, the provisioning behavior of the resource type.String
provisioningTypeAsString()
For resource types, the provisioning behavior of the resource type.List<SdkField<?>>
sdkFields()
static Class<? extends ListTypesRequest.Builder>
serializableBuilderClass()
ListTypesRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.RegistryType
type()
The type of extension.String
typeAsString()
The type of extension.Visibility
visibility()
The scope at which the extensions are visible and usable in CloudFormation operations.String
visibilityAsString()
The scope at which the extensions are visible and usable in CloudFormation operations.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
visibility
public final 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
.If the service returns an enum value that is not available in the current SDK version,
visibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- 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
-
-
visibilityAsString
public final String visibilityAsString()
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
.If the service returns an enum value that is not available in the current SDK version,
visibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- 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
-
-
provisioningType
public final 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
.If the service returns an enum value that is not available in the current SDK version,
provisioningType
will returnProvisioningType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprovisioningTypeAsString()
.- 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
-
-
provisioningTypeAsString
public final String provisioningTypeAsString()
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
.If the service returns an enum value that is not available in the current SDK version,
provisioningType
will returnProvisioningType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprovisioningTypeAsString()
.- 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
-
-
deprecatedStatus
public final 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.
If the service returns an enum value that is not available in the current SDK version,
deprecatedStatus
will returnDeprecatedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeprecatedStatusAsString()
.- 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
-
-
deprecatedStatusAsString
public final String deprecatedStatusAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
deprecatedStatus
will returnDeprecatedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeprecatedStatusAsString()
.- 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
-
-
type
public final RegistryType type()
The type of extension.
If the service returns an enum value that is not available in the current SDK version,
type
will returnRegistryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of extension.
- See Also:
RegistryType
-
typeAsString
public final String typeAsString()
The type of extension.
If the service returns an enum value that is not available in the current SDK version,
type
will returnRegistryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of extension.
- See Also:
RegistryType
-
filters
public final TypeFilters filters()
Filter criteria to use in determining which extensions to return.
Filters must be compatible with
Visibility
to return valid results. For example, specifyingAWS_TYPES
forCategory
andPRIVATE
forVisibility
returns an empty list of types, but specifyingPUBLIC
forVisibility
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, specifyingAWS_TYPES
forCategory
andPRIVATE
forVisibility
returns an empty list of types, but specifyingPUBLIC
forVisibility
returns the desired list.
-
maxResults
public final 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 theNextToken
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 theNextToken
request parameter to get the next set of results.
-
nextToken
public final 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'sNextToken
parameter. If there are no remaining results, the previous response object'sNextToken
parameter is set tonull
.- 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'sNextToken
parameter. If there are no remaining results, the previous response object'sNextToken
parameter is set tonull
.
-
toBuilder
public ListTypesRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListTypesRequest.Builder,ListTypesRequest>
- Specified by:
toBuilder
in classCloudFormationRequest
-
builder
public static ListTypesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListTypesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-