Package software.amazon.awssdk.services.glue.model

Class StartWorkflowRunRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.glue.model.GlueRequest

software.amazon.awssdk.services.glue.model.StartWorkflowRunRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartWorkflowRunRequest.Builder,StartWorkflowRunRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartWorkflowRunRequest
extends GlueRequest
implements ToCopyableBuilder<StartWorkflowRunRequest.Builder,StartWorkflowRunRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartWorkflowRunRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartWorkflowRunRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRunProperties()	For responses, this returns true if the service returned a value for the RunProperties property.
String	name()	The name of the workflow to start.
Map<String,String>	runProperties()	The workflow run properties for the new workflow run.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartWorkflowRunRequest.Builder>	serializableBuilderClass()
StartWorkflowRunRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

The name of the workflow to start.

Returns:

The name of the workflow to start.

hasRunProperties

public final boolean hasRunProperties()

For responses, this returns true if the service returned a value for the RunProperties 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.

runProperties

public final Map<String,String> runProperties()

The workflow run properties for the new workflow run.

Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow 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 hasRunProperties() method.

Returns:

The workflow run properties for the new workflow run.

Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.

toBuilder

public StartWorkflowRunRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartWorkflowRunRequest.Builder,StartWorkflowRunRequest>

Specified by:

toBuilder in class GlueRequest

builder

public static StartWorkflowRunRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartWorkflowRunRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo