Package software.amazon.awssdk.services.backup.model

Class CreateBackupPlanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.backup.model.BackupRequest

software.amazon.awssdk.services.backup.model.CreateBackupPlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBackupPlanRequest.Builder,CreateBackupPlanRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateBackupPlanRequest
extends BackupRequest
implements ToCopyableBuilder<CreateBackupPlanRequest.Builder,CreateBackupPlanRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateBackupPlanRequest.Builder

Method Summary

Modifier and Type	Method	Description
BackupPlanInput	backupPlan()	Specifies the body of a backup plan.
Map<String,String>	backupPlanTags()	To help organize your resources, you can assign your own metadata to the resources that you create.
static CreateBackupPlanRequest.Builder	builder()
String	creatorRequestId()	Identifies the request and allows failed requests to be retried without the risk of running the operation twice.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupPlanTags()	For responses, this returns true if the service returned a value for the BackupPlanTags property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBackupPlanRequest.Builder>	serializableBuilderClass()
CreateBackupPlanRequest.Builder	toBuilder()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

backupPlan

public final BackupPlanInput backupPlan()

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Returns:

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

hasBackupPlanTags

public final boolean hasBackupPlanTags()

For responses, this returns true if the service returned a value for the BackupPlanTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

backupPlanTags

public final Map<String,String> backupPlanTags()

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBackupPlanTags() method.

Returns:

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

creatorRequestId

public final String creatorRequestId()

Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

Returns:

Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

toBuilder

public CreateBackupPlanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBackupPlanRequest.Builder,CreateBackupPlanRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static CreateBackupPlanRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateBackupPlanRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo