Interface Property.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Property.Builder,Property>,SdkBuilder<Property.Builder,Property>,SdkPojo
- Enclosing class:
- Property
@Mutable @NotThreadSafe public static interface Property.Builder extends SdkPojo, CopyableBuilder<Property.Builder,Property>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Property.BuilderallowedValues(Collection<AllowedValue> allowedValues)A list ofAllowedValueobjects representing the values allowed for the property.Property.BuilderallowedValues(Consumer<AllowedValue.Builder>... allowedValues)A list ofAllowedValueobjects representing the values allowed for the property.Property.BuilderallowedValues(AllowedValue... allowedValues)A list ofAllowedValueobjects representing the values allowed for the property.Property.BuilderdataOperationScopes(Collection<DataOperation> dataOperationScopes)Indicates which data operations are applicable to the property.Property.BuilderdataOperationScopes(DataOperation... dataOperationScopes)Indicates which data operations are applicable to the property.Property.BuilderdataOperationScopesWithStrings(String... dataOperationScopes)Indicates which data operations are applicable to the property.Property.BuilderdataOperationScopesWithStrings(Collection<String> dataOperationScopes)Indicates which data operations are applicable to the property.Property.BuilderdefaultValue(String defaultValue)The default value for the property.Property.Builderdescription(String description)A description of the property.Property.BuilderkeyOverride(String keyOverride)A key name to use when sending this property in API requests, if different from the display name.Property.Buildername(String name)The name of the property.Property.BuilderpropertyLocation(String propertyLocation)Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.Property.BuilderpropertyLocation(PropertyLocation propertyLocation)Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.Property.BuilderpropertyTypes(Collection<PropertyType> propertyTypes)Describes the type of property.Property.BuilderpropertyTypes(PropertyType... propertyTypes)Describes the type of property.Property.BuilderpropertyTypesWithStrings(String... propertyTypes)Describes the type of property.Property.BuilderpropertyTypesWithStrings(Collection<String> propertyTypes)Describes the type of property.Property.Builderrequired(Boolean required)Indicates whether the property is required.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
name
Property.Builder name(String name)
The name of the property.
- Parameters:
name- The name of the property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
Property.Builder description(String description)
A description of the property.
- Parameters:
description- A description of the property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
required
Property.Builder required(Boolean required)
Indicates whether the property is required.
- Parameters:
required- Indicates whether the property is required.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultValue
Property.Builder defaultValue(String defaultValue)
The default value for the property.
- Parameters:
defaultValue- The default value for the property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
propertyTypesWithStrings
Property.Builder propertyTypesWithStrings(Collection<String> propertyTypes)
Describes the type of property.
- Parameters:
propertyTypes- Describes the type of property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
propertyTypesWithStrings
Property.Builder propertyTypesWithStrings(String... propertyTypes)
Describes the type of property.
- Parameters:
propertyTypes- Describes the type of property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
propertyTypes
Property.Builder propertyTypes(Collection<PropertyType> propertyTypes)
Describes the type of property.
- Parameters:
propertyTypes- Describes the type of property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
propertyTypes
Property.Builder propertyTypes(PropertyType... propertyTypes)
Describes the type of property.
- Parameters:
propertyTypes- Describes the type of property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowedValues
Property.Builder allowedValues(Collection<AllowedValue> allowedValues)
A list of
AllowedValueobjects representing the values allowed for the property.- Parameters:
allowedValues- A list ofAllowedValueobjects representing the values allowed for the property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowedValues
Property.Builder allowedValues(AllowedValue... allowedValues)
A list of
AllowedValueobjects representing the values allowed for the property.- Parameters:
allowedValues- A list ofAllowedValueobjects representing the values allowed for the property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowedValues
Property.Builder allowedValues(Consumer<AllowedValue.Builder>... allowedValues)
A list of
This is a convenience method that creates an instance of theAllowedValueobjects representing the values allowed for the property.AllowedValue.Builderavoiding the need to create one manually viaAllowedValue.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#allowedValues(List.) - Parameters:
allowedValues- a consumer that will call methods onAllowedValue.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#allowedValues(java.util.Collection)
-
dataOperationScopesWithStrings
Property.Builder dataOperationScopesWithStrings(Collection<String> dataOperationScopes)
Indicates which data operations are applicable to the property.
- Parameters:
dataOperationScopes- Indicates which data operations are applicable to the property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataOperationScopesWithStrings
Property.Builder dataOperationScopesWithStrings(String... dataOperationScopes)
Indicates which data operations are applicable to the property.
- Parameters:
dataOperationScopes- Indicates which data operations are applicable to the property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataOperationScopes
Property.Builder dataOperationScopes(Collection<DataOperation> dataOperationScopes)
Indicates which data operations are applicable to the property.
- Parameters:
dataOperationScopes- Indicates which data operations are applicable to the property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataOperationScopes
Property.Builder dataOperationScopes(DataOperation... dataOperationScopes)
Indicates which data operations are applicable to the property.
- Parameters:
dataOperationScopes- Indicates which data operations are applicable to the property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyOverride
Property.Builder keyOverride(String keyOverride)
A key name to use when sending this property in API requests, if different from the display name.
- Parameters:
keyOverride- A key name to use when sending this property in API requests, if different from the display name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
propertyLocation
Property.Builder propertyLocation(String propertyLocation)
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
- Parameters:
propertyLocation- Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PropertyLocation,PropertyLocation
-
propertyLocation
Property.Builder propertyLocation(PropertyLocation propertyLocation)
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
- Parameters:
propertyLocation- Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PropertyLocation,PropertyLocation
-
-