software.amazon.awssdk.services.appflow.model

Class CreateFlowRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appflow.model.AppflowRequest

software.amazon.awssdk.services.appflow.model.CreateFlowRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFlowRequest.Builder,CreateFlowRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFlowRequest
extends AppflowRequest
implements ToCopyableBuilder<CreateFlowRequest.Builder,CreateFlowRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFlowRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateFlowRequest.Builder	builder()
String	description() A description of the flow you want to create.
List<DestinationFlowConfig>	destinationFlowConfigList() The configuration that controls how Amazon AppFlow places data in the destination connector.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	flowName() The specified name of the flow.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasDestinationFlowConfigList() For responses, this returns true if the service returned a value for the DestinationFlowConfigList property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasTasks() For responses, this returns true if the service returned a value for the Tasks property.
String	kmsArn() The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFlowRequest.Builder>	serializableBuilderClass()
SourceFlowConfig	sourceFlowConfig() The configuration that controls how Amazon AppFlow retrieves data from the source connector.
Map<String,String>	tags() The tags used to organize, track, or control access for your flow.
List<Task>	tasks() A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
CreateFlowRequest.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.
TriggerConfig	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

description

public final String description()

A description of the flow you want to create.

Returns:

A description of the flow you want to create.

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.

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.

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 places data in 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 places data in 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 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.

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.

toBuilder

public CreateFlowRequest.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<CreateFlowRequest.Builder,CreateFlowRequest>

Specified by:

toBuilder in class AppflowRequest

Returns:

a builder for type T

builder

public static CreateFlowRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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

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

Overrides:

getValueForField in class SdkRequest

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.