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

Interface ResetConnectorMetadataCacheRequest.Builder

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

  • Method Details

    • connectorProfileName

      ResetConnectorMetadataCacheRequest.Builder connectorProfileName(String connectorProfileName)

      The name of the connector profile that you want to reset cached metadata for.

      You can omit this parameter if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this parameter in your request.

      Parameters:
      connectorProfileName - The name of the connector profile that you want to reset cached metadata for.

      You can omit this parameter if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this parameter in your request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectorType

      ResetConnectorMetadataCacheRequest.Builder connectorType(String connectorType)

      The type of connector to reset cached metadata for.

      You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.

      Parameters:
      connectorType - The type of connector to reset cached metadata for.

      You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectorType

      ResetConnectorMetadataCacheRequest.Builder connectorType(ConnectorType connectorType)

      The type of connector to reset cached metadata for.

      You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.

      Parameters:
      connectorType - The type of connector to reset cached metadata for.

      You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectorEntityName

      ResetConnectorMetadataCacheRequest.Builder connectorEntityName(String connectorEntityName)

      Use this parameter if you want to reset cached metadata about the details for an individual entity.

      If you don't include this parameter in your request, Amazon AppFlow only resets cached metadata about entity names, not entity details.

      Parameters:
      connectorEntityName - Use this parameter if you want to reset cached metadata about the details for an individual entity.

      If you don't include this parameter in your request, Amazon AppFlow only resets cached metadata about entity names, not entity details.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entitiesPath

      ResetConnectorMetadataCacheRequest.Builder entitiesPath(String entitiesPath)

      Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors support nested entities. A nested entity is one that has another entity as a parent. To use this parameter, specify the name of the parent entity.

      To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that parent.

      Parameters:
      entitiesPath - Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors support nested entities. A nested entity is one that has another entity as a parent. To use this parameter, specify the name of the parent entity.

      To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that parent.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • apiVersion

      ResetConnectorMetadataCacheRequest.Builder apiVersion(String apiVersion)

      The API version that you specified in the connector profile that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector.

      To look up how many versions a connector supports, use the DescribeConnectors action. In the response, find the value that Amazon AppFlow returns for the connectorVersion parameter.

      To look up the connector type, use the DescribeConnectorProfiles action. In the response, find the value that Amazon AppFlow returns for the connectorType parameter.

      To look up the API version that you specified in a connector profile, use the DescribeConnectorProfiles action.

      Parameters:
      apiVersion - The API version that you specified in the connector profile that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector.

      To look up how many versions a connector supports, use the DescribeConnectors action. In the response, find the value that Amazon AppFlow returns for the connectorVersion parameter.

      To look up the connector type, use the DescribeConnectorProfiles action. In the response, find the value that Amazon AppFlow returns for the connectorType parameter.

      To look up the API version that you specified in a connector profile, use the DescribeConnectorProfiles action.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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