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

Interface DescribeFlowResponse.Builder

All Superinterfaces:
AppflowResponse.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<DescribeFlowResponse.Builder,DescribeFlowResponse>, SdkBuilder<DescribeFlowResponse.Builder,DescribeFlowResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeFlowResponse
public static interface DescribeFlowResponse.Builder extends AppflowResponse.Builder, SdkPojo, CopyableBuilder<DescribeFlowResponse.Builder,DescribeFlowResponse>

  • Method Details

    • flowArn

      DescribeFlowResponse.Builder flowArn(String flowArn)

      The flow's Amazon Resource Name (ARN).

      Parameters:
      flowArn - The flow's Amazon Resource Name (ARN).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      DescribeFlowResponse.Builder description(String description)

      A description of the flow.

      Parameters:
      description - A description of the flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • flowName

      DescribeFlowResponse.Builder flowName(String flowName)

      The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

      Parameters:
      flowName - The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsArn

      DescribeFlowResponse.Builder kmsArn(String kmsArn)

      The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

      Parameters:
      kmsArn - The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • flowStatus

      DescribeFlowResponse.Builder flowStatus(String flowStatus)

      Indicates the current status of the flow.

      Parameters:
      flowStatus - Indicates the current status of the flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • flowStatus

      DescribeFlowResponse.Builder flowStatus(FlowStatus flowStatus)

      Indicates the current status of the flow.

      Parameters:
      flowStatus - Indicates the current status of the flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • flowStatusMessage

      DescribeFlowResponse.Builder flowStatusMessage(String flowStatusMessage)

      Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.

      Parameters:
      flowStatusMessage - Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceFlowConfig

      DescribeFlowResponse.Builder sourceFlowConfig(SourceFlowConfig sourceFlowConfig)

      The configuration that controls how Amazon AppFlow retrieves data from the source connector.

      Parameters:
      sourceFlowConfig - The configuration that controls how Amazon AppFlow retrieves data from the source connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceFlowConfig

      default DescribeFlowResponse.Builder sourceFlowConfig(Consumer<SourceFlowConfig.Builder> sourceFlowConfig)

      The configuration that controls how Amazon AppFlow retrieves data from the source connector.

      This is a convenience method that creates an instance of the SourceFlowConfig.Builder avoiding the need to create one manually via SourceFlowConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceFlowConfig(SourceFlowConfig).

      Parameters:
      sourceFlowConfig - a consumer that will call methods on SourceFlowConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • destinationFlowConfigList

      DescribeFlowResponse.Builder destinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList)

      The configuration that controls how Amazon AppFlow transfers data to the destination connector.

      Parameters:
      destinationFlowConfigList - The configuration that controls how Amazon AppFlow transfers data to the destination connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationFlowConfigList

      DescribeFlowResponse.Builder destinationFlowConfigList(DestinationFlowConfig... destinationFlowConfigList)

      The configuration that controls how Amazon AppFlow transfers data to the destination connector.

      Parameters:
      destinationFlowConfigList - The configuration that controls how Amazon AppFlow transfers data to the destination connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationFlowConfigList

      DescribeFlowResponse.Builder destinationFlowConfigList(Consumer<DestinationFlowConfig.Builder>... destinationFlowConfigList)

      The configuration that controls how Amazon AppFlow transfers data to the destination connector.

      This is a convenience method that creates an instance of the DestinationFlowConfig.Builder avoiding the need to create one manually via DestinationFlowConfig.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationFlowConfigList(List<DestinationFlowConfig>).

      Parameters:
      destinationFlowConfigList - a consumer that will call methods on DestinationFlowConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastRunExecutionDetails

      DescribeFlowResponse.Builder lastRunExecutionDetails(ExecutionDetails lastRunExecutionDetails)

      Describes the details of the most recent flow run.

      Parameters:
      lastRunExecutionDetails - Describes the details of the most recent flow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastRunExecutionDetails

      default DescribeFlowResponse.Builder lastRunExecutionDetails(Consumer<ExecutionDetails.Builder> lastRunExecutionDetails)

      Describes the details of the most recent flow run.

      This is a convenience method that creates an instance of the ExecutionDetails.Builder avoiding the need to create one manually via ExecutionDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastRunExecutionDetails(ExecutionDetails).

      Parameters:
      lastRunExecutionDetails - a consumer that will call methods on ExecutionDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • triggerConfig

      DescribeFlowResponse.Builder triggerConfig(TriggerConfig triggerConfig)

      The trigger settings that determine how and when the flow runs.

      Parameters:
      triggerConfig - The trigger settings that determine how and when the flow runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerConfig

      default DescribeFlowResponse.Builder triggerConfig(Consumer<TriggerConfig.Builder> triggerConfig)

      The trigger settings that determine how and when the flow runs.

      This is a convenience method that creates an instance of the TriggerConfig.Builder avoiding the need to create one manually via TriggerConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to triggerConfig(TriggerConfig).

      Parameters:
      triggerConfig - a consumer that will call methods on TriggerConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tasks

      DescribeFlowResponse.Builder tasks(Collection<Task> tasks)

      A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

      Parameters:
      tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tasks

      DescribeFlowResponse.Builder tasks(Task... tasks)

      A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

      Parameters:
      tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tasks

      DescribeFlowResponse.Builder tasks(Consumer<Task.Builder>... tasks)

      A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

      This is a convenience method that creates an instance of the Task.Builder avoiding the need to create one manually via Task.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tasks(List<Task>).

      Parameters:
      tasks - a consumer that will call methods on Task.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      DescribeFlowResponse.Builder createdAt(Instant createdAt)

      Specifies when the flow was created.

      Parameters:
      createdAt - Specifies when the flow was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedAt

      DescribeFlowResponse.Builder lastUpdatedAt(Instant lastUpdatedAt)

      Specifies when the flow was last updated.

      Parameters:
      lastUpdatedAt - Specifies when the flow was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      DescribeFlowResponse.Builder createdBy(String createdBy)

      The ARN of the user who created the flow.

      Parameters:
      createdBy - The ARN of the user who created the flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedBy

      DescribeFlowResponse.Builder lastUpdatedBy(String lastUpdatedBy)

      Specifies the user name of the account that performed the most recent update.

      Parameters:
      lastUpdatedBy - Specifies the user name of the account that performed the most recent update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DescribeFlowResponse.Builder tags(Map<String,String> tags)

      The tags used to organize, track, or control access for your flow.

      Parameters:
      tags - The tags used to organize, track, or control access for your flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataCatalogConfig

      DescribeFlowResponse.Builder metadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig)

      Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

      Parameters:
      metadataCatalogConfig - Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataCatalogConfig

      default DescribeFlowResponse.Builder metadataCatalogConfig(Consumer<MetadataCatalogConfig.Builder> metadataCatalogConfig)

      Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

      This is a convenience method that creates an instance of the MetadataCatalogConfig.Builder avoiding the need to create one manually via MetadataCatalogConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadataCatalogConfig(MetadataCatalogConfig).

      Parameters:
      metadataCatalogConfig - a consumer that will call methods on MetadataCatalogConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastRunMetadataCatalogDetails

      DescribeFlowResponse.Builder lastRunMetadataCatalogDetails(Collection<MetadataCatalogDetail> lastRunMetadataCatalogDetails)

      Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

      Parameters:
      lastRunMetadataCatalogDetails - Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastRunMetadataCatalogDetails

      DescribeFlowResponse.Builder lastRunMetadataCatalogDetails(MetadataCatalogDetail... lastRunMetadataCatalogDetails)

      Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

      Parameters:
      lastRunMetadataCatalogDetails - Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastRunMetadataCatalogDetails

      DescribeFlowResponse.Builder lastRunMetadataCatalogDetails(Consumer<MetadataCatalogDetail.Builder>... lastRunMetadataCatalogDetails)

      Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

      This is a convenience method that creates an instance of the MetadataCatalogDetail.Builder avoiding the need to create one manually via MetadataCatalogDetail.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastRunMetadataCatalogDetails(List<MetadataCatalogDetail>).

      Parameters:
      lastRunMetadataCatalogDetails - a consumer that will call methods on MetadataCatalogDetail.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schemaVersion

      DescribeFlowResponse.Builder schemaVersion(Long schemaVersion)

      The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

      • Source-to-destination field mappings

      • Field data types

      • Partition keys

      Parameters:
      schemaVersion - The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

      • Source-to-destination field mappings

      • Field data types

      • Partition keys

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