Class DescribeFlowResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.appflow.model.AppflowResponse
software.amazon.awssdk.services.appflow.model.DescribeFlowResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeFlowResponse.Builder,DescribeFlowResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeFlowResponse extends AppflowResponse implements ToCopyableBuilder<DescribeFlowResponse.Builder,DescribeFlowResponse>

  • Method Details

    • flowArn

      public final String flowArn()

      The flow's Amazon Resource Name (ARN).

      Returns:
      The flow's Amazon Resource Name (ARN).

    • description

      public final String description()

      A description of the flow.

      Returns:
      A description of the flow.

    • flowName

      public final String flowName()

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

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

    • kmsArn

      public final 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.

      Returns:
      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.

    • flowStatus

      public final FlowStatus flowStatus()

      Indicates the current status of the flow.

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

      Returns:
      Indicates the current status of the flow.
      See Also:

    • flowStatusAsString

      public final String flowStatusAsString()

      Indicates the current status of the flow.

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

      Returns:
      Indicates the current status of the flow.
      See Also:

    • flowStatusMessage

      public final 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.

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

    • sourceFlowConfig

      public final SourceFlowConfig sourceFlowConfig()

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

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

    • hasDestinationFlowConfigList

      public final boolean hasDestinationFlowConfigList()
      For responses, this returns true if the service returned a value for the DestinationFlowConfigList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • destinationFlowConfigList

      public final List<DestinationFlowConfig> destinationFlowConfigList()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinationFlowConfigList() method.

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

    • lastRunExecutionDetails

      public final ExecutionDetails lastRunExecutionDetails()

      Describes the details of the most recent flow run.

      Returns:
      Describes the details of the most recent flow run.

    • triggerConfig

      public final TriggerConfig triggerConfig()

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

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

    • hasTasks

      public final boolean hasTasks()
      For responses, this returns true if the service returned a value for the Tasks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tasks

      public final List<Task> tasks()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTasks() method.

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

    • createdAt

      public final Instant createdAt()

      Specifies when the flow was created.

      Returns:
      Specifies when the flow was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      Specifies when the flow was last updated.

      Returns:
      Specifies when the flow was last updated.

    • createdBy

      public final String createdBy()

      The ARN of the user who created the flow.

      Returns:
      The ARN of the user who created the flow.

    • lastUpdatedBy

      public final String lastUpdatedBy()

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

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

    • metadataCatalogConfig

      public final 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.

      Returns:
      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.

    • hasLastRunMetadataCatalogDetails

      public final boolean hasLastRunMetadataCatalogDetails()
      For responses, this returns true if the service returned a value for the LastRunMetadataCatalogDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • lastRunMetadataCatalogDetails

      public final List<MetadataCatalogDetail> lastRunMetadataCatalogDetails()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLastRunMetadataCatalogDetails() method.

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

    • schemaVersion

      public final 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

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

    • toBuilder

      public DescribeFlowResponse.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<DescribeFlowResponse.Builder,DescribeFlowResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeFlowResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeFlowResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.