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>

  • Method Details

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

    • scope

      public final ConnectionScope scope()

      The scope of the connection.

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

      Returns:
      The scope of the connection.
      See Also:

    • scopeAsString

      public final String scopeAsString()

      The scope of the connection.

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

      Returns:
      The scope of the connection.
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public ListConnectionsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListConnectionsRequest.Builder,ListConnectionsRequest>
      Specified by:
      toBuilder in class DataZoneRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.