CreateEndpointGroupRequest (AWS SDK for Java

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.CreateEndpointGroupRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateEndpointGroupRequest.Builder,CreateEndpointGroupRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateEndpointGroupRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateEndpointGroupRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateEndpointGroupRequest.Builder`	`builder()`
`List<EndpointConfiguration>`	`endpointConfigurations()` The list of endpoint objects.
`String`	`endpointGroupRegion()` The name of the AWS Region where the endpoint group is located.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`Integer`	`healthCheckIntervalSeconds()` The time, in 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 AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group.
`HealthCheckProtocol`	`healthCheckProtocol()` The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group.
`String`	`healthCheckProtocolAsString()` The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group.
`String`	`idempotencyToken()` A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
`String`	`listenerArn()` The Amazon Resource Name (ARN) of the listener.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateEndpointGroupRequest.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.
`CreateEndpointGroupRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Float`	`trafficDialPercentage()` The percentage of traffic to send to an AWS Region.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - listenerArn
```
public String listenerArn()
```
    The Amazon Resource Name (ARN) of the listener.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the listener.
  - endpointGroupRegion
```
public String endpointGroupRegion()
```
    The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
    
    Returns:
    
    The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
  - endpointConfigurations
```
public List<EndpointConfiguration> endpointConfigurations()
```
    The list of endpoint objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The list of endpoint objects.
  - trafficDialPercentage
```
public Float trafficDialPercentage()
```
    The percentage of traffic to send to an AWS 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 AWS 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 Integer healthCheckPort()
```
    The port that AWS 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 listener port is a list of ports, Global Accelerator uses the first port in the list.
    
    Returns:
    
    The port that AWS 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 listener port is a list of ports, Global Accelerator uses the first port in the list.
  - healthCheckProtocol
```
public HealthCheckProtocol healthCheckProtocol()
```
    The protocol that AWS 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 AWS 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 String healthCheckProtocolAsString()
```
    The protocol that AWS 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 AWS 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 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 Integer healthCheckIntervalSeconds()
```
    The time, in seconds, between each health check for an endpoint. The default value is 30.
    
    Returns:
    
    The time, in seconds, between each health check for an endpoint. The default value is 30.
  - thresholdCount
```
public 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.
  - idempotencyToken
```
public String idempotencyToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
  - toBuilder
```
public CreateEndpointGroupRequest.Builder 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 interface ToCopyableBuilder<CreateEndpointGroupRequest.Builder,CreateEndpointGroupRequest>
    
    Specified by:
    
    toBuilder in class GlobalAcceleratorRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateEndpointGroupRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateEndpointGroupRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class CreateEndpointGroupRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

listenerArn

endpointGroupRegion

endpointConfigurations

trafficDialPercentage

healthCheckPort

healthCheckProtocol

healthCheckProtocolAsString

healthCheckPath

healthCheckIntervalSeconds

thresholdCount

idempotencyToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields