Class Property
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Property.Builder,
Property>
An object that defines a connection type for a compute environment.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AllowedValue> A list ofAllowedValue
objects representing the values allowed for the property.static Property.Builder
builder()
final List
<DataOperation> Indicates which data operations are applicable to the property.Indicates which data operations are applicable to the property.final String
The default value for the property.final String
A description of the property.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AllowedValues property.final boolean
For responses, this returns true if the service returned a value for the DataOperationScopes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PropertyTypes property.final String
name()
The name of the property.final List
<PropertyType> Describes the type of property.Describes the type of property.final Boolean
required()
Indicates whether the property is required.static Class
<? extends Property.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
-
description
A description of the property.
- Returns:
- A description of the property.
-
required
Indicates whether the property is required.
- Returns:
- Indicates whether the property is required.
-
defaultValue
The default value for the property.
- Returns:
- The default value for the property.
-
propertyTypes
Describes the type of property.
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
hasPropertyTypes()
method.- Returns:
- Describes the type of property.
-
hasPropertyTypes
public final boolean hasPropertyTypes()For responses, this returns true if the service returned a value for the PropertyTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
propertyTypesAsStrings
Describes the type of property.
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
hasPropertyTypes()
method.- Returns:
- Describes the type of property.
-
hasAllowedValues
public final boolean hasAllowedValues()For responses, this returns true if the service returned a value for the AllowedValues property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
allowedValues
A list of
AllowedValue
objects representing the values allowed for the property.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
hasAllowedValues()
method.- Returns:
- A list of
AllowedValue
objects representing the values allowed for the property.
-
dataOperationScopes
Indicates which data operations are applicable to the property.
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
hasDataOperationScopes()
method.- Returns:
- Indicates which data operations are applicable to the property.
-
hasDataOperationScopes
public final boolean hasDataOperationScopes()For responses, this returns true if the service returned a value for the DataOperationScopes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
dataOperationScopesAsStrings
Indicates which data operations are applicable to the property.
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
hasDataOperationScopes()
method.- Returns:
- Indicates which data operations are applicable to the property.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Property.Builder,
Property> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-