software.amazon.awssdk.services.opsworkscm.model

Class DescribeBackupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opsworkscm.model.OpsWorksCMRequest

software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest

All Implemented Interfaces:

ToCopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeBackupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	backupId() Describes a single backup.
static DescribeBackupsRequest.Builder	builder()
boolean	equals(Object obj)
<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()
Integer	maxResults() To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call.
String	nextToken() NextToken is a string that is returned in some command responses.
static Class<? extends DescribeBackupsRequest.Builder>	serializableBuilderClass()
String	serverName() Returns backups for the server with the specified ServerName.
DescribeBackupsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

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

backupId

public String backupId()

Describes a single backup.

Returns:

Describes a single backup.

serverName

public String serverName()

Returns backups for the server with the specified ServerName.

Returns:

Returns backups for the server with the specified ServerName.

nextToken

public String nextToken()

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeBackups again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

Returns:

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeBackups again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

maxResults

public Integer maxResults()

To receive a paginated response, use this parameter to specify 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:

To receive a paginated response, use this parameter to specify 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.

toBuilder

public DescribeBackupsRequest.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<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

Specified by:

toBuilder in class OpsWorksCMRequest

Returns:

a builder for type T

builder

public static DescribeBackupsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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