Package software.amazon.awssdk.services.neptunegraph.model

Class StartExportTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.neptunegraph.model.NeptuneGraphRequest

software.amazon.awssdk.services.neptunegraph.model.StartExportTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartExportTaskRequest.Builder,StartExportTaskRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartExportTaskRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartExportTaskRequest.Builder	builder()
String	destination()	The Amazon S3 URI where data will be exported to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExportFilter	exportFilter()	The export filter of the export task.
ExportFormat	format()	The format of the export task.
String	formatAsString()	The format of the export task.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	graphIdentifier()	The source graph identifier of the export task.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	kmsKeyIdentifier()	The KMS key identifier of the export task.
ParquetType	parquetType()	The parquet type of the export task.
String	parquetTypeAsString()	The parquet type of the export task.
String	roleArn()	The ARN of the IAM role that will allow data to be exported to the destination.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartExportTaskRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Tags to be applied to the export task.
StartExportTaskRequest.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

graphIdentifier

public final String graphIdentifier()

The source graph identifier of the export task.

Returns:

The source graph identifier of the export task.

roleArn

public final String roleArn()

The ARN of the IAM role that will allow data to be exported to the destination.

Returns:

The ARN of the IAM role that will allow data to be exported to the destination.

format

public final ExportFormat format()

The format of the export task.

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

Returns:

The format of the export task.

See Also:

ExportFormat

formatAsString

public final String formatAsString()

The format of the export task.

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

Returns:

The format of the export task.

See Also:

ExportFormat

destination

public final String destination()

The Amazon S3 URI where data will be exported to.

Returns:

The Amazon S3 URI where data will be exported to.

kmsKeyIdentifier

public final String kmsKeyIdentifier()

The KMS key identifier of the export task.

Returns:

The KMS key identifier of the export task.

parquetType

public final ParquetType parquetType()

The parquet type of the export task.

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

Returns:

The parquet type of the export task.

See Also:

ParquetType

parquetTypeAsString

public final String parquetTypeAsString()

The parquet type of the export task.

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

Returns:

The parquet type of the export task.

See Also:

ParquetType

exportFilter

public final ExportFilter exportFilter()

The export filter of the export task.

Returns:

The export filter of the export task.

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()

Tags to be applied to the export task.

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:

Tags to be applied to the export task.

toBuilder

public StartExportTaskRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartExportTaskRequest.Builder,StartExportTaskRequest>

Specified by:

toBuilder in class NeptuneGraphRequest

builder

public static StartExportTaskRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo