Class UpdateFlowRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateFlowRequest.Builder,
UpdateFlowRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UpdateFlowRequest.Builder
builder()
final String
TheclientToken
parameter is an idempotency token.final String
A description of the flow.final List
<DestinationFlowConfig> The configuration that controls how Amazon AppFlow transfers data to the destination connector.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
flowName()
The specified name of the flow.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DestinationFlowConfigList property.final int
hashCode()
final boolean
hasTasks()
For responses, this returns true if the service returned a value for the Tasks property.final MetadataCatalogConfig
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow.static Class
<? extends UpdateFlowRequest.Builder> final SourceFlowConfig
Returns the value of the SourceFlowConfig property for this object.tasks()
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TriggerConfig
The trigger settings that determine how and when the flow runs.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
description
A description of the flow.
- Returns:
- A description of the flow.
-
triggerConfig
The trigger settings that determine how and when the flow runs.
- Returns:
- The trigger settings that determine how and when the flow runs.
-
sourceFlowConfig
Returns the value of the SourceFlowConfig property for this object.- Returns:
- The value of the SourceFlowConfig property for this object.
-
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 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. -
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.
-
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 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. -
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.
-
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.
-
clientToken
The
clientToken
parameter is an idempotency token. It ensures that yourUpdateFlow
request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the sameclientToken
parameter value.If you omit a
clientToken
value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.If you specify input parameters that differ from your first request, an error occurs. If you use a different value for
clientToken
, Amazon AppFlow considers it a new call toUpdateFlow
. The token is active for 8 hours.- Returns:
- The
clientToken
parameter is an idempotency token. It ensures that yourUpdateFlow
request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the sameclientToken
parameter value.If you omit a
clientToken
value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.If you specify input parameters that differ from your first request, an error occurs. If you use a different value for
clientToken
, Amazon AppFlow considers it a new call toUpdateFlow
. The token is active for 8 hours.
-
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 interfaceToCopyableBuilder<UpdateFlowRequest.Builder,
UpdateFlowRequest> - Specified by:
toBuilder
in classAppflowRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-