Class FlowDefinition
- java.lang.Object
-
- software.amazon.awssdk.services.appflow.model.FlowDefinition
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FlowDefinition.Builder,FlowDefinition>
@Generated("software.amazon.awssdk:codegen") public final class FlowDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FlowDefinition.Builder,FlowDefinition>
The properties of the flow, such as its source, destination, trigger type, and so on.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
FlowDefinition.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FlowDefinition.Builder
builder()
Instant
createdAt()
Specifies when the flow was created.String
createdBy()
The ARN of the user who created the flow.String
description()
A user-entered description of the flow.String
destinationConnectorLabel()
The label of the destination connector in the flow.ConnectorType
destinationConnectorType()
Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.String
destinationConnectorTypeAsString()
Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
flowArn()
The flow's Amazon Resource Name (ARN).String
flowName()
The specified name of the flow.FlowStatus
flowStatus()
Indicates the current status of the flow.String
flowStatusAsString()
Indicates the current status of the flow.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.ExecutionDetails
lastRunExecutionDetails()
Describes the details of the most recent flow run.Instant
lastUpdatedAt()
Specifies when the flow was last updated.String
lastUpdatedBy()
Specifies the account user name that most recently updated the flow.List<SdkField<?>>
sdkFields()
static Class<? extends FlowDefinition.Builder>
serializableBuilderClass()
String
sourceConnectorLabel()
The label of the source connector in the flow.ConnectorType
sourceConnectorType()
Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.String
sourceConnectorTypeAsString()
Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.Map<String,String>
tags()
The tags used to organize, track, or control access for your flow.FlowDefinition.Builder
toBuilder()
String
toString()
Returns a string representation of this object.TriggerType
triggerType()
Specifies the type of flow trigger.String
triggerTypeAsString()
Specifies the type of flow trigger.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 user-entered description of the flow.
- Returns:
- A user-entered 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.
-
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 returnFlowStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromflowStatusAsString()
.- Returns:
- Indicates the current status of the flow.
- See Also:
FlowStatus
-
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 returnFlowStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromflowStatusAsString()
.- Returns:
- Indicates the current status of the flow.
- See Also:
FlowStatus
-
sourceConnectorType
public final ConnectorType sourceConnectorType()
Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
If the service returns an enum value that is not available in the current SDK version,
sourceConnectorType
will returnConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceConnectorTypeAsString()
.- Returns:
- Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
- See Also:
ConnectorType
-
sourceConnectorTypeAsString
public final String sourceConnectorTypeAsString()
Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
If the service returns an enum value that is not available in the current SDK version,
sourceConnectorType
will returnConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceConnectorTypeAsString()
.- Returns:
- Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
- See Also:
ConnectorType
-
sourceConnectorLabel
public final String sourceConnectorLabel()
The label of the source connector in the flow.
- Returns:
- The label of the source connector in the flow.
-
destinationConnectorType
public final ConnectorType destinationConnectorType()
Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
If the service returns an enum value that is not available in the current SDK version,
destinationConnectorType
will returnConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdestinationConnectorTypeAsString()
.- Returns:
- Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
- See Also:
ConnectorType
-
destinationConnectorTypeAsString
public final String destinationConnectorTypeAsString()
Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
If the service returns an enum value that is not available in the current SDK version,
destinationConnectorType
will returnConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdestinationConnectorTypeAsString()
.- Returns:
- Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
- See Also:
ConnectorType
-
destinationConnectorLabel
public final String destinationConnectorLabel()
The label of the destination connector in the flow.
- Returns:
- The label of the destination connector in the flow.
-
triggerType
public final TriggerType triggerType()
Specifies the type of flow trigger. This can be
OnDemand
,Scheduled
, orEvent
.If the service returns an enum value that is not available in the current SDK version,
triggerType
will returnTriggerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtriggerTypeAsString()
.- Returns:
- Specifies the type of flow trigger. This can be
OnDemand
,Scheduled
, orEvent
. - See Also:
TriggerType
-
triggerTypeAsString
public final String triggerTypeAsString()
Specifies the type of flow trigger. This can be
OnDemand
,Scheduled
, orEvent
.If the service returns an enum value that is not available in the current SDK version,
triggerType
will returnTriggerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtriggerTypeAsString()
.- Returns:
- Specifies the type of flow trigger. This can be
OnDemand
,Scheduled
, orEvent
. - See Also:
TriggerType
-
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 account user name that most recently updated the flow.
- Returns:
- Specifies the account user name that most recently updated the flow.
-
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 theisEmpty()
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.
-
lastRunExecutionDetails
public final ExecutionDetails lastRunExecutionDetails()
Describes the details of the most recent flow run.
- Returns:
- Describes the details of the most recent flow run.
-
toBuilder
public FlowDefinition.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<FlowDefinition.Builder,FlowDefinition>
-
builder
public static FlowDefinition.Builder builder()
-
serializableBuilderClass
public static Class<? extends FlowDefinition.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-