Package software.amazon.smithy.rulesengine.aws.language.functions.partition

Class Partition

java.lang.Object

software.amazon.smithy.rulesengine.aws.language.functions.partition.Partition

All Implemented Interfaces:

FromSourceLocation, ToNode, ToSmithyBuilder<Partition>

public final class Partition
extends java.lang.Object
implements ToSmithyBuilder<Partition>, FromSourceLocation, ToNode

Describes an AWS partition, its regions, and the outputs to be provided from the rule-set aws.partition function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Partition.Builder	A builder used to create a Partition class.

Method Summary

Modifier and Type	Method	Description
static Partition.Builder	builder()	Builder to create a Partition instance.
boolean	equals(java.lang.Object o)
static Partition	fromNode(Node node)	Creates a Partition instance from the given Node information.
java.lang.String	getId()	Gets the ID of the partition.
PartitionOutputs	getOutputs()	Gets the supported configuration output for this partition.
java.lang.String	getRegionRegex()	Gets the regular expression to match regions in this partition.
java.util.Map<java.lang.String,RegionOverride>	getRegions()	Gets this partition's map of region names to region-specific overriding data.
SourceLocation	getSourceLocation()	Gets the source location of a value.
int	hashCode()
Partition.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Node	toNode()	Converts a value to a Node.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static Partition.Builder builder()

Builder to create a Partition instance.

Returns:

returns a new Builder.

fromNode

public static Partition fromNode(Node node)

Creates a Partition instance from the given Node information.

Parameters:

node - the node to deserialize.

Returns:

the created Partition.

getId

public java.lang.String getId()

Gets the ID of the partition.

Returns:

returns the partition's ID.

getRegionRegex

public java.lang.String getRegionRegex()

Gets the regular expression to match regions in this partition.

Returns:

returns the regular expression to match regions in this partition.

getRegions

public java.util.Map<java.lang.String,RegionOverride> getRegions()

Gets this partition's map of region names to region-specific overriding data.

Returns:

returns a map of region names to region-specific overriding data.

getOutputs

public PartitionOutputs getOutputs()

Gets the supported configuration output for this partition.

Returns:

returns the partition's configuration outputs.

getSourceLocation

public SourceLocation getSourceLocation()

Description copied from interface: FromSourceLocation

Gets the source location of a value.

Specified by:

getSourceLocation in interface FromSourceLocation

Returns:

Returns the source location of the value.

toBuilder

public Partition.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<Partition>

Returns:

a builder for type T

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object