Interface ListConnectorEntitiesRequest.Builder

All Superinterfaces:
AppflowRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<ListConnectorEntitiesRequest.Builder,ListConnectorEntitiesRequest>, SdkBuilder<ListConnectorEntitiesRequest.Builder,ListConnectorEntitiesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListConnectorEntitiesRequest
@Mutable @NotThreadSafe public static interface ListConnectorEntitiesRequest.Builder extends AppflowRequest.Builder, SdkPojo, CopyableBuilder<ListConnectorEntitiesRequest.Builder,ListConnectorEntitiesRequest>

  • Method Details

    • connectorProfileName

      ListConnectorEntitiesRequest.Builder connectorProfileName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • connectorType

      ListConnectorEntitiesRequest.Builder connectorType(String connectorType)

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

      Parameters:
      connectorType - The type of connector, such as Salesforce, Amplitude, and so on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectorType

      ListConnectorEntitiesRequest.Builder connectorType(ConnectorType connectorType)

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

      Parameters:
      connectorType - The type of connector, such as Salesforce, Amplitude, and so on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • entitiesPath

      ListConnectorEntitiesRequest.Builder entitiesPath(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • apiVersion

      ListConnectorEntitiesRequest.Builder apiVersion(String apiVersion)

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

      Parameters:
      apiVersion - The version of the API that's used by the connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListConnectorEntitiesRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - The maximum number of items that the operation returns in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListConnectorEntitiesRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListConnectorEntitiesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListConnectorEntitiesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.