Class CreateLegalHoldRequest
- 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.CreateLegalHoldRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateLegalHoldRequest.Builder,CreateLegalHoldRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLegalHoldRequest extends BackupRequest implements ToCopyableBuilder<CreateLegalHoldRequest.Builder,CreateLegalHoldRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateLegalHoldRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateLegalHoldRequest.Builderbuilder()Stringdescription()This is the string description of the legal hold.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringidempotencyToken()This is a user-chosen string used to distinguish between otherwise identical calls.RecoveryPointSelectionrecoveryPointSelection()This specifies criteria to assign a set of resources, such as resource types or backup vaults.List<SdkField<?>>sdkFields()static Class<? extends CreateLegalHoldRequest.Builder>serializableBuilderClass()Map<String,String>tags()Optional tags to include.Stringtitle()This is the string title of the legal hold.CreateLegalHoldRequest.BuildertoBuilder()StringtoString()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
-
title
public final String title()
This is the string title of the legal hold.
- Returns:
- This is the string title of the legal hold.
-
description
public final String description()
This is the string description of the legal hold.
- Returns:
- This is the string description of the legal hold.
-
idempotencyToken
public final String idempotencyToken()
This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.
- Returns:
- This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.
-
recoveryPointSelection
public final RecoveryPointSelection recoveryPointSelection()
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
- Returns:
- This specifies criteria to assign a set of resources, such as resource types or backup vaults.
-
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
public final Map<String,String> tags()
Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
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:
- Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
-
toBuilder
public CreateLegalHoldRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateLegalHoldRequest.Builder,CreateLegalHoldRequest>- Specified by:
toBuilderin classBackupRequest
-
builder
public static CreateLegalHoldRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateLegalHoldRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-