Class CopyBackupRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CopyBackupRequest.Builder,
CopyBackupRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CopyBackupRequest.Builder
builder()
final String
Returns the value of the ClientRequestToken property for this object.final Boolean
copyTags()
A Boolean flag indicating whether tags from the source backup should be copied to the backup copy.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
Returns the value of the KmsKeyId property for this object.static Class
<? extends CopyBackupRequest.Builder> final String
The ID of the source backup.final String
The source Amazon Web Services Region of the backup.tags()
Returns the value of the Tags property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clientRequestToken
Returns the value of the ClientRequestToken property for this object.- Returns:
- The value of the ClientRequestToken property for this object.
-
sourceBackupId
The ID of the source backup. Specifies the ID of the backup that's being copied.
- Returns:
- The ID of the source backup. Specifies the ID of the backup that's being copied.
-
sourceRegion
The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region,
SourceRegion
defaults to the Region where the request is sent from (in-Region copy).- Returns:
- The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which
the backup is being copied. The source and destination Regions must be in the same Amazon Web Services
partition. If you don't specify a Region,
SourceRegion
defaults to the Region where the request is sent from (in-Region copy).
-
kmsKeyId
Returns the value of the KmsKeyId property for this object.- Returns:
- The value of the KmsKeyId property for this object.
-
copyTags
A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to
false
.If you set
CopyTags
totrue
and the source backup has existing tags, you can use theTags
parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with theTags
parameter take precedence.- Returns:
- A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This
value defaults to
false
.If you set
CopyTags
totrue
and the source backup has existing tags, you can use theTags
parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with theTags
parameter take precedence.
-
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 theisEmpty()
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
Returns the value of the Tags property for this object.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:
- The value of the Tags property for this object.
-
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 interfaceToCopyableBuilder<CopyBackupRequest.Builder,
CopyBackupRequest> - Specified by:
toBuilder
in classFSxRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-