@Generated(value="software.amazon.awssdk:codegen") public final class ListDeploymentsRequest extends CodeDeployRequest implements ToCopyableBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>
Represents the input of a ListDeployments
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
ListDeploymentsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
applicationName()
The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
|
static ListDeploymentsRequest.Builder |
builder() |
TimeRange |
createTimeRange()
A time range (start and end) for returning a subset of the list of deployments.
|
String |
deploymentGroupName()
The name of a deployment group for the specified application.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
externalId()
The unique ID of an external resource for returning deployments linked to the external resource.
|
<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() |
boolean |
hasIncludeOnlyStatuses()
Returns true if the IncludeOnlyStatuses property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
List<DeploymentStatus> |
includeOnlyStatuses()
A subset of deployments to list by status:
|
List<String> |
includeOnlyStatusesAsStrings()
A subset of deployments to list by status:
|
String |
nextToken()
An identifier returned from the previous list deployments call.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListDeploymentsRequest.Builder> |
serializableBuilderClass() |
ListDeploymentsRequest.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.
|
overrideConfiguration
copy
public final String applicationName()
The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
If applicationName
is specified, then deploymentGroupName
must be specified. If it is
not specified, then deploymentGroupName
must not be specified.
If applicationName
is specified, then deploymentGroupName
must be specified. If
it is not specified, then deploymentGroupName
must not be specified.
public final String deploymentGroupName()
The name of a deployment group for the specified application.
If deploymentGroupName
is specified, then applicationName
must be specified. If it is
not specified, then applicationName
must not be specified.
If deploymentGroupName
is specified, then applicationName
must be specified. If
it is not specified, then applicationName
must not be specified.
public final String externalId()
The unique ID of an external resource for returning deployments linked to the external resource.
public final List<DeploymentStatus> includeOnlyStatuses()
A subset of deployments to list by status:
Created
: Include created deployments in the resulting list.
Queued
: Include queued deployments in the resulting list.
In Progress
: Include in-progress deployments in the resulting list.
Succeeded
: Include successful deployments in the resulting list.
Failed
: Include failed deployments in the resulting list.
Stopped
: Include stopped deployments in the resulting list.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasIncludeOnlyStatuses()
to see if a value was sent in this field.
Created
: Include created deployments in the resulting list.
Queued
: Include queued deployments in the resulting list.
In Progress
: Include in-progress deployments in the resulting list.
Succeeded
: Include successful deployments in the resulting list.
Failed
: Include failed deployments in the resulting list.
Stopped
: Include stopped deployments in the resulting list.
public final boolean hasIncludeOnlyStatuses()
public final List<String> includeOnlyStatusesAsStrings()
A subset of deployments to list by status:
Created
: Include created deployments in the resulting list.
Queued
: Include queued deployments in the resulting list.
In Progress
: Include in-progress deployments in the resulting list.
Succeeded
: Include successful deployments in the resulting list.
Failed
: Include failed deployments in the resulting list.
Stopped
: Include stopped deployments in the resulting list.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasIncludeOnlyStatuses()
to see if a value was sent in this field.
Created
: Include created deployments in the resulting list.
Queued
: Include queued deployments in the resulting list.
In Progress
: Include in-progress deployments in the resulting list.
Succeeded
: Include successful deployments in the resulting list.
Failed
: Include failed deployments in the resulting list.
Stopped
: Include stopped deployments in the resulting list.
public final TimeRange createTimeRange()
A time range (start and end) for returning a subset of the list of deployments.
public final String nextToken()
An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
public ListDeploymentsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListDeploymentsRequest.Builder,ListDeploymentsRequest>
toBuilder
in class CodeDeployRequest
public static ListDeploymentsRequest.Builder builder()
public static Class<? extends ListDeploymentsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.