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

Class ExportFilter

java.lang.Object

software.amazon.awssdk.services.neptunegraph.model.ExportFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExportFilter.Builder,ExportFilter>

@Generated("software.amazon.awssdk:codegen")
public final class ExportFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExportFilter.Builder,ExportFilter>

This is the top-level field for specifying vertex or edge filters. If the ExportFilter is not provided, then all properties for all labels will be exported. If the ExportFilter is provided but is an empty object, then no data will be exported.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExportFilter.Builder

Method Summary

Modifier and Type	Method	Description
static ExportFilter.Builder	builder()
Map<String,ExportFilterElement>	edgeFilter()	Used to specify filters on a per-label basis for edges.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEdgeFilter()	For responses, this returns true if the service returned a value for the EdgeFilter property.
int	hashCode()
boolean	hasVertexFilter()	For responses, this returns true if the service returned a value for the VertexFilter property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ExportFilter.Builder>	serializableBuilderClass()
ExportFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Map<String,ExportFilterElement>	vertexFilter()	Used to specify filters on a per-label basis for vertices.

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

hasVertexFilter

public final boolean hasVertexFilter()

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

vertexFilter

public final Map<String,ExportFilterElement> vertexFilter()

Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels and properties are included in the export.

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

Returns:

Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels and properties are included in the export.

hasEdgeFilter

public final boolean hasEdgeFilter()

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

edgeFilter

public final Map<String,ExportFilterElement> edgeFilter()

Used to specify filters on a per-label basis for edges. This allows you to control which edge labels and properties are included in the export.

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

Returns:

Used to specify filters on a per-label basis for edges. This allows you to control which edge labels and properties are included in the export.

toBuilder

public ExportFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExportFilter.Builder,ExportFilter>

builder

public static ExportFilter.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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