@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
FlowDefinition.Builder |
Modifier and Type | Method and 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.
|
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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
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() |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
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.
|
copy
public final String flowArn()
The flow's Amazon Resource Name (ARN).
public final String description()
A user-entered description of the flow.
public final String flowName()
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
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()
.
FlowStatus
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()
.
FlowStatus
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 return ConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by
the service is available from sourceConnectorTypeAsString()
.
ConnectorType
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 return ConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by
the service is available from sourceConnectorTypeAsString()
.
ConnectorType
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 return ConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from destinationConnectorTypeAsString()
.
ConnectorType
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 return ConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from destinationConnectorTypeAsString()
.
ConnectorType
public final TriggerType triggerType()
Specifies the type of flow trigger. This can be OnDemand
, Scheduled
, or
Event
.
If the service returns an enum value that is not available in the current SDK version, triggerType
will
return TriggerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
triggerTypeAsString()
.
OnDemand
, Scheduled
, or
Event
.TriggerType
public final String triggerTypeAsString()
Specifies the type of flow trigger. This can be OnDemand
, Scheduled
, or
Event
.
If the service returns an enum value that is not available in the current SDK version, triggerType
will
return TriggerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
triggerTypeAsString()
.
OnDemand
, Scheduled
, or
Event
.TriggerType
public final Instant createdAt()
Specifies when the flow was created.
public final Instant lastUpdatedAt()
Specifies when the flow was last updated.
public final String createdBy()
The ARN of the user who created the flow.
public final String lastUpdatedBy()
Specifies the account user name that most recently updated the flow.
public final boolean hasTags()
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.
You can use hasTags()
to see if a value was sent in this field.
public final ExecutionDetails lastRunExecutionDetails()
Describes the details of the most recent flow run.
public FlowDefinition.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<FlowDefinition.Builder,FlowDefinition>
public static FlowDefinition.Builder builder()
public static Class<? extends FlowDefinition.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.