software.amazon.awssdk.services.finspacedata.model

Class CreateChangesetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.finspacedata.model.FinspaceDataRequest

software.amazon.awssdk.services.finspacedata.model.CreateChangesetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateChangesetRequest.Builder,CreateChangesetRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateChangesetRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateChangesetRequest.Builder	builder()
ChangeType	changeType() Option to indicate how a changeset will be applied to a dataset.
String	changeTypeAsString() Option to indicate how a changeset will be applied to a dataset.
String	datasetId() The unique identifier for the FinSpace dataset in which the changeset will be created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,String>	formatParams() Options that define the structure of the source file(s).
FormatType	formatType() Format type of the input files being loaded into the changeset.
String	formatTypeAsString() Format type of the input files being loaded into the changeset.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFormatParams() For responses, this returns true if the service returned a value for the FormatParams property.
int	hashCode()
boolean	hasSourceParams() For responses, this returns true if the service returned a value for the SourceParams property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateChangesetRequest.Builder>	serializableBuilderClass()
Map<String,String>	sourceParams() Source path from which the files to create the changeset will be sourced.
SourceType	sourceType() Type of the data source from which the files to create the changeset will be sourced.
String	sourceTypeAsString() Type of the data source from which the files to create the changeset will be sourced.
Map<String,String>	tags() Metadata tags to apply to this changeset.
CreateChangesetRequest.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

datasetId

public final String datasetId()

The unique identifier for the FinSpace dataset in which the changeset will be created.

Returns:

The unique identifier for the FinSpace dataset in which the changeset will be created.

changeType

public final ChangeType changeType()

Option to indicate how a changeset will be applied to a dataset.

• REPLACE - Changeset will be considered as a replacement to all prior loaded changesets.

• APPEND - Changeset will be considered as an addition to the end of all prior loaded changesets.

If the service returns an enum value that is not available in the current SDK version, changeType will return ChangeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from changeTypeAsString().

Returns:

Option to indicate how a changeset will be applied to a dataset.

• REPLACE - Changeset will be considered as a replacement to all prior loaded changesets.

• APPEND - Changeset will be considered as an addition to the end of all prior loaded changesets.

See Also:

ChangeType

changeTypeAsString

public final String changeTypeAsString()

Option to indicate how a changeset will be applied to a dataset.

• REPLACE - Changeset will be considered as a replacement to all prior loaded changesets.

• APPEND - Changeset will be considered as an addition to the end of all prior loaded changesets.

If the service returns an enum value that is not available in the current SDK version, changeType will return ChangeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from changeTypeAsString().

Returns:

Option to indicate how a changeset will be applied to a dataset.

• REPLACE - Changeset will be considered as a replacement to all prior loaded changesets.

• APPEND - Changeset will be considered as an addition to the end of all prior loaded changesets.

See Also:

ChangeType

sourceType

public final SourceType sourceType()

Type of the data source from which the files to create the changeset will be sourced.

• S3 - Amazon S3.

If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

Type of the data source from which the files to create the changeset will be sourced.

• S3 - Amazon S3.

See Also:

SourceType

sourceTypeAsString

public final String sourceTypeAsString()

Type of the data source from which the files to create the changeset will be sourced.

• S3 - Amazon S3.

If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

Type of the data source from which the files to create the changeset will be sourced.

• S3 - Amazon S3.

See Also:

SourceType

hasSourceParams

public final boolean hasSourceParams()

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

sourceParams

public final Map<String,String> sourceParams()

Source path from which the files to create the changeset will be sourced.

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

Returns:

Source path from which the files to create the changeset will be sourced.

formatType

public final FormatType formatType()

Format type of the input files being loaded into the changeset.

If the service returns an enum value that is not available in the current SDK version, formatType will return FormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatTypeAsString().

Returns:

Format type of the input files being loaded into the changeset.

See Also:

FormatType

formatTypeAsString

public final String formatTypeAsString()

Format type of the input files being loaded into the changeset.

If the service returns an enum value that is not available in the current SDK version, formatType will return FormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatTypeAsString().

Returns:

Format type of the input files being loaded into the changeset.

See Also:

FormatType

hasFormatParams

public final boolean hasFormatParams()

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

formatParams

public final Map<String,String> formatParams()

Options that define the structure of the source file(s).

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

Returns:

Options that define the structure of the source file(s).

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 Map<String,String> tags()

Metadata tags to apply to this changeset.

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:

Metadata tags to apply to this changeset.

toBuilder

public CreateChangesetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateChangesetRequest.Builder,CreateChangesetRequest>

Specified by:

toBuilder in class FinspaceDataRequest

builder

public static CreateChangesetRequest.Builder builder()

serializableBuilderClass

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