Package software.amazon.awssdk.services.appflow.model

Class ListConnectorEntitiesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appflow.model.AppflowRequest

software.amazon.awssdk.services.appflow.model.ListConnectorEntitiesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListConnectorEntitiesRequest.Builder,ListConnectorEntitiesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListConnectorEntitiesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	apiVersion()	The version of the API that's used by the connector.
static ListConnectorEntitiesRequest.Builder	builder()
String	connectorProfileName()	The name of the connector profile.
ConnectorType	connectorType()	The type of connector, such as Salesforce, Amplitude, and so on.
String	connectorTypeAsString()	The type of connector, such as Salesforce, Amplitude, and so on.
String	entitiesPath()	This optional parameter is specific to connector implementation.
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 items that the operation returns in the response.
String	nextToken()	A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size.
List<SdkField<?>>	sdkFields()
static Class<? extends ListConnectorEntitiesRequest.Builder>	serializableBuilderClass()
ListConnectorEntitiesRequest.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

connectorProfileName

public final String connectorProfileName()

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.

Returns:

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.

connectorType

public final ConnectorType connectorType()

The type of connector, such as Salesforce, Amplitude, and so on.

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

Returns:

The type of connector, such as Salesforce, Amplitude, and so on.

See Also:

ConnectorType

connectorTypeAsString

public final String connectorTypeAsString()

The type of connector, such as Salesforce, Amplitude, and so on.

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

Returns:

The type of connector, such as Salesforce, Amplitude, and so on.

See Also:

ConnectorType

entitiesPath

public final String entitiesPath()

This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.

Returns:

This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.

apiVersion

public final String apiVersion()

The version of the API that's used by the connector.

Returns:

The version of the API that's used by the connector.

maxResults

public final Integer maxResults()

The maximum number of items that the operation returns in the response.

Returns:

The maximum number of items that the operation returns in the response.

nextToken

public final String nextToken()

A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.

Returns:

A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.

toBuilder

public ListConnectorEntitiesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListConnectorEntitiesRequest.Builder,ListConnectorEntitiesRequest>

Specified by:

toBuilder in class AppflowRequest

builder

public static ListConnectorEntitiesRequest.Builder builder()

serializableBuilderClass

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