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

Class CreateFrameworkRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFrameworkRequest.Builder,CreateFrameworkRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateFrameworkRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateFrameworkRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FrameworkControl>	frameworkControls()	A list of the controls that make up the framework.
String	frameworkDescription()	An optional description of the framework with a maximum of 1,024 characters.
String	frameworkName()	The unique name of the framework.
Map<String,String>	frameworkTags()	Metadata that you can assign to help organize the frameworks that you create.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFrameworkControls()	For responses, this returns true if the service returned a value for the FrameworkControls property.
boolean	hasFrameworkTags()	For responses, this returns true if the service returned a value for the FrameworkTags property.
int	hashCode()
String	idempotencyToken()	A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFrameworkRequest.Builder>	serializableBuilderClass()
CreateFrameworkRequest.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

frameworkName

public final String frameworkName()

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Returns:

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

frameworkDescription

public final String frameworkDescription()

An optional description of the framework with a maximum of 1,024 characters.

Returns:

An optional description of the framework with a maximum of 1,024 characters.

hasFrameworkControls

public final boolean hasFrameworkControls()

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

frameworkControls

public final List<FrameworkControl> frameworkControls()

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

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

Returns:

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

idempotencyToken

public final String idempotencyToken()

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Returns:

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

hasFrameworkTags

public final boolean hasFrameworkTags()

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

frameworkTags

public final Map<String,String> frameworkTags()

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

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

Returns:

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

toBuilder

public CreateFrameworkRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFrameworkRequest.Builder,CreateFrameworkRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static CreateFrameworkRequest.Builder builder()

serializableBuilderClass

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