Package software.amazon.awssdk.services.datazone.model

Class ListConnectionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datazone.model.DataZoneRequest

software.amazon.awssdk.services.datazone.model.ListConnectionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListConnectionsRequest.Builder,ListConnectionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListConnectionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListConnectionsRequest.Builder	builder()
String	domainIdentifier()	The ID of the domain where you want to list connections.
String	environmentIdentifier()	The ID of the environment where you want to list connections.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of connections to return in a single call to ListConnections.
String	name()	The name of the connection.
String	nextToken()	When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken.
String	projectIdentifier()	The ID of the project where you want to list connections.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListConnectionsRequest.Builder>	serializableBuilderClass()
SortFieldConnection	sortBy()	Specifies how you want to sort the listed connections.
String	sortByAsString()	Specifies how you want to sort the listed connections.
SortOrder	sortOrder()	Specifies the sort order for the listed connections.
String	sortOrderAsString()	Specifies the sort order for the listed connections.
ListConnectionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ConnectionType	type()	The type of connection.
String	typeAsString()	The type of connection.

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

domainIdentifier

public final String domainIdentifier()

The ID of the domain where you want to list connections.

Returns:

The ID of the domain where you want to list connections.

environmentIdentifier

public final String environmentIdentifier()

The ID of the environment where you want to list connections.

Returns:

The ID of the environment where you want to list connections.

maxResults

public final Integer maxResults()

The maximum number of connections to return in a single call to ListConnections. When the number of connections to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListConnections to list the next set of connections.

Returns:

The maximum number of connections to return in a single call to ListConnections. When the number of connections to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListConnections to list the next set of connections.

name

public final String name()

The name of the connection.

Returns:

The name of the connection.

nextToken

public final String nextToken()

When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.

Returns:

When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.

projectIdentifier

public final String projectIdentifier()

The ID of the project where you want to list connections.

Returns:

The ID of the project where you want to list connections.

sortBy

public final SortFieldConnection sortBy()

Specifies how you want to sort the listed connections.

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

Returns:

Specifies how you want to sort the listed connections.

See Also:

SortFieldConnection

sortByAsString

public final String sortByAsString()

Specifies how you want to sort the listed connections.

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

Returns:

Specifies how you want to sort the listed connections.

See Also:

SortFieldConnection

sortOrder

public final SortOrder sortOrder()

Specifies the sort order for the listed connections.

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

Returns:

Specifies the sort order for the listed connections.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

Specifies the sort order for the listed connections.

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

Returns:

Specifies the sort order for the listed connections.

See Also:

SortOrder

type

public final ConnectionType type()

The type of connection.

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

Returns:

The type of connection.

See Also:

ConnectionType

typeAsString

public final String typeAsString()

The type of connection.

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

Returns:

The type of connection.

See Also:

ConnectionType

toBuilder

public ListConnectionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListConnectionsRequest.Builder,ListConnectionsRequest>

Specified by:

toBuilder in class DataZoneRequest

builder

public static ListConnectionsRequest.Builder builder()

serializableBuilderClass

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