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>

  • Method Details

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

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

    • 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()
      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<ListConnectorEntitiesRequest.Builder,ListConnectorEntitiesRequest>
      Specified by:
      toBuilder in class AppflowRequest
      Returns:
      a builder for type T

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