Package software.amazon.awssdk.services.opsworkscm.model

Class CreateBackupRequest

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.CreateBackupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBackupRequest.Builder,CreateBackupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateBackupRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateBackupRequest.Builder	builder()
String	description()	A user-defined description of the backup.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBackupRequest.Builder>	serializableBuilderClass()
String	serverName()	The name of the server that you want to back up.
List<Tag>	tags()	A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.
CreateBackupRequest.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

serverName

public final String serverName()

The name of the server that you want to back up.

Returns:

The name of the server that you want to back up.

description

public final String description()

A user-defined description of the backup.

Returns:

A user-defined description of the backup.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.

• The key cannot be empty.

• The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

• The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

• Leading and trailing white spaces are trimmed from both the key and value.

• A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.

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 hasTags() method.

Returns:

A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.

• The key cannot be empty.

• The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

• The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

• Leading and trailing white spaces are trimmed from both the key and value.

• A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.

toBuilder

public CreateBackupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBackupRequest.Builder,CreateBackupRequest>

Specified by:

toBuilder in class OpsWorksCmRequest

builder

public static CreateBackupRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo