software.amazon.awssdk.services.globalaccelerator.model

Class EndpointGroup

java.lang.Object

software.amazon.awssdk.services.globalaccelerator.model.EndpointGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EndpointGroup.Builder,EndpointGroup>

@Generated(value="software.amazon.awssdk:codegen")
public final class EndpointGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EndpointGroup.Builder,EndpointGroup>

A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EndpointGroup.Builder

Method Summary

Modifier and Type	Method and Description
static EndpointGroup.Builder	builder()
List<EndpointDescription>	endpointDescriptions() The list of endpoint objects.
String	endpointGroupArn() The Amazon Resource Name (ARN) of the endpoint group.
String	endpointGroupRegion() The Amazon Web Services Region where the endpoint group is located.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEndpointDescriptions() For responses, this returns true if the service returned a value for the EndpointDescriptions 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 health checks for each endpoint.
String	healthCheckPath() If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.
Integer	healthCheckPort() The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
HealthCheckProtocol	healthCheckProtocol() The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
String	healthCheckProtocolAsString() The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
List<PortOverride>	portOverrides() Allows you to override the destination ports used to route traffic to an endpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends EndpointGroup.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.
EndpointGroup.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 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.

endpointGroupRegion

public final String endpointGroupRegion()

The Amazon Web Services Region where the endpoint group is located.

Returns:

The Amazon Web Services Region where the endpoint group is located.

hasEndpointDescriptions

public final boolean hasEndpointDescriptions()

For responses, this returns true if the service returned a value for the EndpointDescriptions 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.

endpointDescriptions

public final List<EndpointDescription> endpointDescriptions()

The list of endpoint objects.

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 hasEndpointDescriptions() method.

Returns:

The list of endpoint objects.

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 perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

Returns:

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

healthCheckProtocol

public final HealthCheckProtocol healthCheckProtocol()

The protocol that Global Accelerator uses to perform health checks on 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 perform health checks on 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 perform health checks on 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 perform health checks on 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 value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

Returns:

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

healthCheckIntervalSeconds

public final Integer healthCheckIntervalSeconds()

The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

Returns:

The time—10 seconds or 30 seconds—between health checks for each 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()

Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

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:

Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

toBuilder

public EndpointGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EndpointGroup.Builder,EndpointGroup>

builder

public static EndpointGroup.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo