Package software.amazon.awssdk.services.lightsail.model

Class CreateContactMethodRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.CreateContactMethodRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateContactMethodRequest.Builder,CreateContactMethodRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateContactMethodRequest
extends LightsailRequest
implements ToCopyableBuilder<CreateContactMethodRequest.Builder,CreateContactMethodRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateContactMethodRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateContactMethodRequest.Builder	builder()
String	contactEndpoint()	The destination of the contact method, such as an email address or a mobile phone number.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ContactProtocol	protocol()	The protocol of the contact method, such as Email or SMS (text messaging).
String	protocolAsString()	The protocol of the contact method, such as Email or SMS (text messaging).
List<SdkField<?>>	sdkFields()
static Class<? extends CreateContactMethodRequest.Builder>	serializableBuilderClass()
CreateContactMethodRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

protocol

public final ContactProtocol protocol()

The protocol of the contact method, such as Email or SMS (text messaging).

The SMS protocol is supported only in the following Amazon Web Services Regions.

• US East (N. Virginia) (us-east-1)

• US West (Oregon) (us-west-2)

• Europe (Ireland) (eu-west-1)

• Asia Pacific (Tokyo) (ap-northeast-1)

• Asia Pacific (Singapore) (ap-southeast-1)

• Asia Pacific (Sydney) (ap-southeast-2)

For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

If the service returns an enum value that is not available in the current SDK version, protocol will return ContactProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

The protocol of the contact method, such as Email or SMS (text messaging).

The SMS protocol is supported only in the following Amazon Web Services Regions.

• US East (N. Virginia) (us-east-1)

• US West (Oregon) (us-west-2)

• Europe (Ireland) (eu-west-1)

• Asia Pacific (Tokyo) (ap-northeast-1)

• Asia Pacific (Singapore) (ap-southeast-1)

• Asia Pacific (Sydney) (ap-southeast-2)

For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

See Also:

ContactProtocol

protocolAsString

public final String protocolAsString()

The protocol of the contact method, such as Email or SMS (text messaging).

The SMS protocol is supported only in the following Amazon Web Services Regions.

• US East (N. Virginia) (us-east-1)

• US West (Oregon) (us-west-2)

• Europe (Ireland) (eu-west-1)

• Asia Pacific (Tokyo) (ap-northeast-1)

• Asia Pacific (Singapore) (ap-southeast-1)

• Asia Pacific (Sydney) (ap-southeast-2)

For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

If the service returns an enum value that is not available in the current SDK version, protocol will return ContactProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

The protocol of the contact method, such as Email or SMS (text messaging).

The SMS protocol is supported only in the following Amazon Web Services Regions.

• US East (N. Virginia) (us-east-1)

• US West (Oregon) (us-west-2)

• Europe (Ireland) (eu-west-1)

• Asia Pacific (Tokyo) (ap-northeast-1)

• Asia Pacific (Singapore) (ap-southeast-1)

• Asia Pacific (Sydney) (ap-southeast-2)

For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

See Also:

ContactProtocol

contactEndpoint

public final String contactEndpoint()

The destination of the contact method, such as an email address or a mobile phone number.

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.

Returns:

The destination of the contact method, such as an email address or a mobile phone number.

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.

toBuilder

public CreateContactMethodRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateContactMethodRequest.Builder,CreateContactMethodRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static CreateContactMethodRequest.Builder builder()

serializableBuilderClass

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