Package software.amazon.awssdk.services.databrew.model

Class CreateRulesetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.databrew.model.DataBrewRequest

software.amazon.awssdk.services.databrew.model.CreateRulesetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRulesetRequest.Builder,CreateRulesetRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateRulesetRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateRulesetRequest.Builder	builder()
String	description()	The description of the ruleset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRules()	For responses, this returns true if the service returned a value for the Rules property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The name of the ruleset to be created.
List<Rule>	rules()	A list of rules that are defined with the ruleset.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRulesetRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Metadata tags to apply to the ruleset.
String	targetArn()	The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
CreateRulesetRequest.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 ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Returns:

The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

description

public final String description()

The description of the ruleset.

Returns:

The description of the ruleset.

targetArn

public final String targetArn()

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

Returns:

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

hasRules

public final boolean hasRules()

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

rules

public final List<Rule> rules()

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

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

Returns:

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

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()

Metadata tags to apply to the ruleset.

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:

Metadata tags to apply to the ruleset.

toBuilder

public CreateRulesetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRulesetRequest.Builder,CreateRulesetRequest>

Specified by:

toBuilder in class DataBrewRequest

builder

public static CreateRulesetRequest.Builder builder()

serializableBuilderClass

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