Class EndpointSetting
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EndpointSetting.Builder,
EndpointSetting>
Endpoint settings.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The relevance or validity of an endpoint setting for an engine name and its endpoint type.static EndpointSetting.Builder
builder()
final String
The default value of the endpoint setting if no value is specified usingCreateEndpoint
orModifyEndpoint
.Enumerated values to use for this endpoint.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 EnumValues property.final int
hashCode()
final Integer
The maximum value of an endpoint setting that is of typeint
.final Integer
The minimum value of an endpoint setting that is of typeint
.final String
name()
The name that you want to give the endpoint settings.final Boolean
A value that marks this endpoint setting as sensitive.static Class
<? extends EndpointSetting.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.final EndpointSettingTypeValue
type()
The type of endpoint.final String
The type of endpoint.final String
units()
The unit of measure for this endpoint setting.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name that you want to give the endpoint settings.
- Returns:
- The name that you want to give the endpoint settings.
-
type
The type of endpoint. Valid values are
source
andtarget
.If the service returns an enum value that is not available in the current SDK version,
type
will returnEndpointSettingTypeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of endpoint. Valid values are
source
andtarget
. - See Also:
-
typeAsString
The type of endpoint. Valid values are
source
andtarget
.If the service returns an enum value that is not available in the current SDK version,
type
will returnEndpointSettingTypeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of endpoint. Valid values are
source
andtarget
. - See Also:
-
hasEnumValues
public final boolean hasEnumValues()For responses, this returns true if the service returned a value for the EnumValues 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. -
enumValues
Enumerated values to use for this endpoint.
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
hasEnumValues()
method.- Returns:
- Enumerated values to use for this endpoint.
-
sensitive
A value that marks this endpoint setting as sensitive.
- Returns:
- A value that marks this endpoint setting as sensitive.
-
units
The unit of measure for this endpoint setting.
- Returns:
- The unit of measure for this endpoint setting.
-
applicability
The relevance or validity of an endpoint setting for an engine name and its endpoint type.
- Returns:
- The relevance or validity of an endpoint setting for an engine name and its endpoint type.
-
intValueMin
The minimum value of an endpoint setting that is of type
int
.- Returns:
- The minimum value of an endpoint setting that is of type
int
.
-
intValueMax
The maximum value of an endpoint setting that is of type
int
.- Returns:
- The maximum value of an endpoint setting that is of type
int
.
-
defaultValue
The default value of the endpoint setting if no value is specified using
CreateEndpoint
orModifyEndpoint
.- Returns:
- The default value of the endpoint setting if no value is specified using
CreateEndpoint
orModifyEndpoint
.
-
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<EndpointSetting.Builder,
EndpointSetting> - 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.
-