software.amazon.awssdk.services.globalaccelerator.model

Class UpdateEndpointGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.globalaccelerator.model.GlobalAcceleratorRequest

software.amazon.awssdk.services.globalaccelerator.model.UpdateEndpointGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateEndpointGroupRequest.Builder,UpdateEndpointGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateEndpointGroupRequest
extends GlobalAcceleratorRequest
implements ToCopyableBuilder<UpdateEndpointGroupRequest.Builder,UpdateEndpointGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateEndpointGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateEndpointGroupRequest.Builder	builder()
List<EndpointConfiguration>	endpointConfigurations() The list of endpoint objects.
String	endpointGroupArn() The Amazon Resource Name (ARN) of the endpoint group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEndpointConfigurations() For responses, this returns true if the service returned a value for the EndpointConfigurations property.
int	hashCode()
boolean	hasPortOverrides() For responses, this returns true if the service returned a value for the PortOverrides property.
Integer	healthCheckIntervalSeconds() The time—10 seconds or 30 seconds—between each health check for an endpoint.
String	healthCheckPath() If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets.
Integer	healthCheckPort() The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group.
HealthCheckProtocol	healthCheckProtocol() The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group.
String	healthCheckProtocolAsString() The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group.
List<PortOverride>	portOverrides() Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateEndpointGroupRequest.Builder>	serializableBuilderClass()
Integer	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.
UpdateEndpointGroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Float	trafficDialPercentage() 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 class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

endpointGroupArn

public final String 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 the isEmpty() 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

public final List<EndpointConfiguration> 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

public final Float 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

public final Integer 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

public final HealthCheckProtocol 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 return HealthCheckProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().

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:

HealthCheckProtocol

healthCheckProtocolAsString

public final String 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 return HealthCheckProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().

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:

HealthCheckProtocol

healthCheckPath

public final String 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

public final Integer 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

public final Integer 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 the isEmpty() 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

public final List<PortOverride> 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

public UpdateEndpointGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateEndpointGroupRequest.Builder,UpdateEndpointGroupRequest>

Specified by:

toBuilder in class GlobalAcceleratorRequest

builder

public static UpdateEndpointGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateEndpointGroupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo