software.amazon.awssdk.services.directconnect.model

Class StartBgpFailoverTestRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.directconnect.model.DirectConnectRequest

software.amazon.awssdk.services.directconnect.model.StartBgpFailoverTestRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartBgpFailoverTestRequest.Builder,StartBgpFailoverTestRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartBgpFailoverTestRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	bgpPeers() The BGP peers to place in the DOWN state.
static StartBgpFailoverTestRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBgpPeers() For responses, this returns true if the service returned a value for the BgpPeers property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends StartBgpFailoverTestRequest.Builder>	serializableBuilderClass()
Integer	testDurationInMinutes() The time in minutes that the virtual interface failover test will last.
StartBgpFailoverTestRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	virtualInterfaceId() The ID of the virtual interface you want to test.

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

virtualInterfaceId

public final String virtualInterfaceId()

The ID of the virtual interface you want to test.

Returns:

The ID of the virtual interface you want to test.

hasBgpPeers

public final boolean hasBgpPeers()

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

bgpPeers

public final List<String> bgpPeers()

The BGP peers to place in the DOWN state.

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

Returns:

The BGP peers to place in the DOWN state.

testDurationInMinutes

public final Integer testDurationInMinutes()

The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

Returns:

The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

toBuilder

public StartBgpFailoverTestRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartBgpFailoverTestRequest.Builder,StartBgpFailoverTestRequest>

Specified by:

toBuilder in class DirectConnectRequest

builder

public static StartBgpFailoverTestRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartBgpFailoverTestRequest.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