Package software.amazon.awssdk.services.clouddirectory.model

Class ListOutgoingTypedLinksRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListOutgoingTypedLinksRequest.Builder,ListOutgoingTypedLinksRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListOutgoingTypedLinksRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListOutgoingTypedLinksRequest.Builder	builder()
ConsistencyLevel	consistencyLevel()	The consistency level to execute the request at.
String	consistencyLevelAsString()	The consistency level to execute the request at.
String	directoryArn()	The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<TypedLinkAttributeRange>	filterAttributeRanges()	Provides range filters for multiple attributes.
TypedLinkSchemaAndFacetName	filterTypedLink()	Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilterAttributeRanges()	For responses, this returns true if the service returned a value for the FilterAttributeRanges property.
int	hashCode()
Integer	maxResults()	The maximum number of results to retrieve.
String	nextToken()	The pagination token.
ObjectReference	objectReference()	A reference that identifies the object whose attributes will be listed.
List<SdkField<?>>	sdkFields()
static Class<? extends ListOutgoingTypedLinksRequest.Builder>	serializableBuilderClass()
ListOutgoingTypedLinksRequest.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

directoryArn

public final String directoryArn()

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

Returns:

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

objectReference

public final ObjectReference objectReference()

A reference that identifies the object whose attributes will be listed.

Returns:

A reference that identifies the object whose attributes will be listed.

hasFilterAttributeRanges

public final boolean hasFilterAttributeRanges()

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

filterAttributeRanges

public final List<TypedLinkAttributeRange> filterAttributeRanges()

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

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

Returns:

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

filterTypedLink

public final TypedLinkSchemaAndFacetName filterTypedLink()

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

Returns:

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

nextToken

public final String nextToken()

The pagination token.

Returns:

The pagination token.

maxResults

public final Integer maxResults()

The maximum number of results to retrieve.

Returns:

The maximum number of results to retrieve.

consistencyLevel

public final ConsistencyLevel consistencyLevel()

The consistency level to execute the request at.

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

Returns:

The consistency level to execute the request at.

See Also:

ConsistencyLevel

consistencyLevelAsString

public final String consistencyLevelAsString()

The consistency level to execute the request at.

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

Returns:

The consistency level to execute the request at.

See Also:

ConsistencyLevel

toBuilder

public ListOutgoingTypedLinksRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListOutgoingTypedLinksRequest.Builder,ListOutgoingTypedLinksRequest>

Specified by:

toBuilder in class CloudDirectoryRequest

builder

public static ListOutgoingTypedLinksRequest.Builder builder()

serializableBuilderClass

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