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

Class UpdateWorkflowRequest

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.UpdateWorkflowRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateWorkflowRequest.Builder,UpdateWorkflowRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateWorkflowRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateWorkflowRequest.Builder	builder()
Map<String,String>	defaultRunProperties()	A collection of properties to be used as part of each execution of the workflow.
String	description()	The description of the workflow.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDefaultRunProperties()	For responses, this returns true if the service returned a value for the DefaultRunProperties property.
int	hashCode()
Integer	maxConcurrentRuns()	You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs.
String	name()	Name of the workflow to be updated.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateWorkflowRequest.Builder>	serializableBuilderClass()
UpdateWorkflowRequest.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()

Name of the workflow to be updated.

Returns:

Name of the workflow to be updated.

description

public final String description()

The description of the workflow.

Returns:

The description of the workflow.

hasDefaultRunProperties

public final boolean hasDefaultRunProperties()

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

defaultRunProperties

public final Map<String,String> defaultRunProperties()

A collection of properties to be used as part of each execution of the workflow.

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 hasDefaultRunProperties() method.

Returns:

A collection of properties to be used as part of each execution of the workflow.

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.

maxConcurrentRuns

public final Integer maxConcurrentRuns()

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

Returns:

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

toBuilder

public UpdateWorkflowRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateWorkflowRequest.Builder,UpdateWorkflowRequest>

Specified by:

toBuilder in class GlueRequest

builder

public static UpdateWorkflowRequest.Builder builder()

serializableBuilderClass

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