software.amazon.awssdk.services.codedeploy.model

Class ListApplicationRevisionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codedeploy.model.CodeDeployRequest

software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListApplicationRevisionsRequest.Builder,ListApplicationRevisionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListApplicationRevisionsRequest
extends CodeDeployRequest
implements ToCopyableBuilder<ListApplicationRevisionsRequest.Builder,ListApplicationRevisionsRequest>

Represents the input of a ListApplicationRevisions operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListApplicationRevisionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationName() The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
static ListApplicationRevisionsRequest.Builder	builder()
ListStateFilterAction	deployed() Whether to list revisions based on whether the revision is the target revision of a deployment group:
String	deployedAsString() Whether to list revisions based on whether the revision is the target revision of a deployment group:
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	nextToken() An identifier returned from the previous ListApplicationRevisions call.
String	s3Bucket() An Amazon S3 bucket name to limit the search for revisions.
String	s3KeyPrefix() A key prefix for the set of Amazon S3 objects to limit the search for revisions.
List<SdkField<?>>	sdkFields()
static Class<? extends ListApplicationRevisionsRequest.Builder>	serializableBuilderClass()
ApplicationRevisionSortBy	sortBy() The column name to use to sort the list results:
String	sortByAsString() The column name to use to sort the list results:
SortOrder	sortOrder() The order in which to sort the list results:
String	sortOrderAsString() The order in which to sort the list results:
ListApplicationRevisionsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationName

public final String applicationName()

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

Returns:

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

sortBy

public final ApplicationRevisionSortBy sortBy()

The column name to use to sort the list results:

• registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.

• firstUsedTime: Sort by the time the revisions were first used in a deployment.

• lastUsedTime: Sort by the time the revisions were last used in a deployment.

If not specified or set to null, the results are returned in an arbitrary order.

If the service returns an enum value that is not available in the current SDK version, sortBy will return ApplicationRevisionSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

The column name to use to sort the list results:

• registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.

• firstUsedTime: Sort by the time the revisions were first used in a deployment.

• lastUsedTime: Sort by the time the revisions were last used in a deployment.

If not specified or set to null, the results are returned in an arbitrary order.

See Also:

ApplicationRevisionSortBy

sortByAsString

public final String sortByAsString()

The column name to use to sort the list results:

• registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.

• firstUsedTime: Sort by the time the revisions were first used in a deployment.

• lastUsedTime: Sort by the time the revisions were last used in a deployment.

If not specified or set to null, the results are returned in an arbitrary order.

If the service returns an enum value that is not available in the current SDK version, sortBy will return ApplicationRevisionSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

The column name to use to sort the list results:

• registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.

• firstUsedTime: Sort by the time the revisions were first used in a deployment.

• lastUsedTime: Sort by the time the revisions were last used in a deployment.

If not specified or set to null, the results are returned in an arbitrary order.

See Also:

ApplicationRevisionSortBy

sortOrder

public final SortOrder sortOrder()

The order in which to sort the list results:

• ascending: ascending order.

• descending: descending order.

If not specified, the results are sorted in ascending order.

If set to null, the results are sorted in an arbitrary order.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

The order in which to sort the list results:

• ascending: ascending order.

• descending: descending order.

If not specified, the results are sorted in ascending order.

If set to null, the results are sorted in an arbitrary order.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

The order in which to sort the list results:

• ascending: ascending order.

• descending: descending order.

If not specified, the results are sorted in ascending order.

If set to null, the results are sorted in an arbitrary order.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

The order in which to sort the list results:

• ascending: ascending order.

• descending: descending order.

If not specified, the results are sorted in ascending order.

If set to null, the results are sorted in an arbitrary order.

See Also:

SortOrder

s3Bucket

public final String s3Bucket()

An Amazon S3 bucket name to limit the search for revisions.

If set to null, all of the user's buckets are searched.

Returns:

An Amazon S3 bucket name to limit the search for revisions.

If set to null, all of the user's buckets are searched.

s3KeyPrefix

public final String s3KeyPrefix()

A key prefix for the set of Amazon S3 objects to limit the search for revisions.

Returns:

A key prefix for the set of Amazon S3 objects to limit the search for revisions.

deployed

public final ListStateFilterAction deployed()

Whether to list revisions based on whether the revision is the target revision of a deployment group:

• include: List revisions that are target revisions of a deployment group.

• exclude: Do not list revisions that are target revisions of a deployment group.

• ignore: List all revisions.

If the service returns an enum value that is not available in the current SDK version, deployed will return ListStateFilterAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deployedAsString().

Returns:

Whether to list revisions based on whether the revision is the target revision of a deployment group:

• include: List revisions that are target revisions of a deployment group.

• exclude: Do not list revisions that are target revisions of a deployment group.

• ignore: List all revisions.

See Also:

ListStateFilterAction

deployedAsString

public final String deployedAsString()

Whether to list revisions based on whether the revision is the target revision of a deployment group:

• include: List revisions that are target revisions of a deployment group.

• exclude: Do not list revisions that are target revisions of a deployment group.

• ignore: List all revisions.

If the service returns an enum value that is not available in the current SDK version, deployed will return ListStateFilterAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deployedAsString().

Returns:

Whether to list revisions based on whether the revision is the target revision of a deployment group:

• include: List revisions that are target revisions of a deployment group.

• exclude: Do not list revisions that are target revisions of a deployment group.

• ignore: List all revisions.

See Also:

ListStateFilterAction

nextToken

public final String nextToken()

An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.

Returns:

An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.

toBuilder

public ListApplicationRevisionsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListApplicationRevisionsRequest.Builder,ListApplicationRevisionsRequest>

Specified by:

toBuilder in class CodeDeployRequest

Returns:

a builder for type T

builder

public static ListApplicationRevisionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListApplicationRevisionsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.