Class UpdateEndpointGroupRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateEndpointGroupRequest.Builder,
UpdateEndpointGroupRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final List
<EndpointConfiguration> The list of endpoint objects.final String
The Amazon Resource Name (ARN) of the endpoint group.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the EndpointConfigurations property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PortOverrides property.final Integer
The time—10 seconds or 30 seconds—between each health check for an endpoint.final String
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets.final Integer
The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group.final HealthCheckProtocol
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group.final String
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group.final List
<PortOverride> Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.static Class
<? extends UpdateEndpointGroupRequest.Builder> final Integer
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.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 Float
The percentage of traffic to send to an Amazon Web Services Region.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
- Returns:
- The Amazon Resource Name (ARN) of the endpoint group.
-
hasEndpointConfigurations
public final boolean hasEndpointConfigurations()For responses, this returns true if the service returned a value for the EndpointConfigurations 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. -
endpointConfigurations
The list of endpoint objects. A resource must be valid and active when you add it as an 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
hasEndpointConfigurations()
method.- Returns:
- The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
-
trafficDialPercentage
The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
- Returns:
- The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to
other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
-
healthCheckPort
The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.
- Returns:
- The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.
-
healthCheckProtocol
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
If the service returns an enum value that is not available in the current SDK version,
healthCheckProtocol
will returnHealthCheckProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthCheckProtocolAsString()
.- Returns:
- The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
- See Also:
-
healthCheckProtocolAsString
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
If the service returns an enum value that is not available in the current SDK version,
healthCheckProtocol
will returnHealthCheckProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthCheckProtocolAsString()
.- Returns:
- The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
- See Also:
-
healthCheckPath
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
- Returns:
- If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
-
healthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
- Returns:
- The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
-
thresholdCount
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
- Returns:
- The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
-
hasPortOverrides
public final boolean hasPortOverrides()For responses, this returns true if the service returned a value for the PortOverrides 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. -
portOverrides
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
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
hasPortOverrides()
method.- Returns:
- Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.
For example, you can create a port override in which the listener receives user traffic on ports 80 and
443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
-
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<UpdateEndpointGroupRequest.Builder,
UpdateEndpointGroupRequest> - Specified by:
toBuilder
in classGlobalAcceleratorRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-