software.amazon.awssdk.services.clouddirectory.model

Class UpgradeAppliedSchemaRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.clouddirectory.model.CloudDirectoryRequest

software.amazon.awssdk.services.clouddirectory.model.UpgradeAppliedSchemaRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpgradeAppliedSchemaRequest.Builder,UpgradeAppliedSchemaRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpgradeAppliedSchemaRequest
extends CloudDirectoryRequest
implements ToCopyableBuilder<UpgradeAppliedSchemaRequest.Builder,UpgradeAppliedSchemaRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpgradeAppliedSchemaRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpgradeAppliedSchemaRequest.Builder	builder()
String	directoryArn() The ARN for the directory to which the upgraded schema will be applied.
Boolean	dryRun() Used for testing whether the major version schemas are backward compatible or not.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	publishedSchemaArn() The revision of the published schema to upgrade the directory to.
List<SdkField<?>>	sdkFields()
static Class<? extends UpgradeAppliedSchemaRequest.Builder>	serializableBuilderClass()
UpgradeAppliedSchemaRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

publishedSchemaArn

public String publishedSchemaArn()

The revision of the published schema to upgrade the directory to.

Returns:

The revision of the published schema to upgrade the directory to.

directoryArn

public String directoryArn()

The ARN for the directory to which the upgraded schema will be applied.

Returns:

The ARN for the directory to which the upgraded schema will be applied.

dryRun

public Boolean dryRun()

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

Returns:

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

toBuilder

public UpgradeAppliedSchemaRequest.Builder 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 interface ToCopyableBuilder<UpgradeAppliedSchemaRequest.Builder,UpgradeAppliedSchemaRequest>

Specified by:

toBuilder in class CloudDirectoryRequest

Returns:

a builder for type T

builder

public static UpgradeAppliedSchemaRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpgradeAppliedSchemaRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.