Package software.amazon.awssdk.services.ssmcontacts.model

Class CreateContactRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssmcontacts.model.SsmContactsRequest

software.amazon.awssdk.services.ssmcontacts.model.CreateContactRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateContactRequest.Builder,CreateContactRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateContactRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	alias()	The short name to quickly identify a contact or escalation plan.
static CreateContactRequest.Builder	builder()
String	displayName()	The full name of the contact or escalation plan.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	idempotencyToken()	A token ensuring that the operation is called only once with the specified details.
Plan	plan()	A list of stages.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateContactRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Adds a tag to the target.
CreateContactRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ContactType	type()	To create an escalation plan use ESCALATION.
String	typeAsString()	To create an escalation plan use ESCALATION.

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

alias

public final String alias()

The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.

Returns:

The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.

displayName

public final String displayName()

The full name of the contact or escalation plan.

Returns:

The full name of the contact or escalation plan.

type

public final ContactType type()

To create an escalation plan use ESCALATION. To create a contact use PERSONAL.

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

Returns:

To create an escalation plan use ESCALATION. To create a contact use PERSONAL.

See Also:

ContactType

typeAsString

public final String typeAsString()

To create an escalation plan use ESCALATION. To create a contact use PERSONAL.

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

Returns:

To create an escalation plan use ESCALATION. To create a contact use PERSONAL.

See Also:

ContactType

plan

public final Plan plan()

A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

Returns:

A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

Adds a tag to the target. You can only tag resources created in the first Region of your replication set.

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

Returns:

Adds a tag to the target. You can only tag resources created in the first Region of your replication set.

idempotencyToken

public final String idempotencyToken()

A token ensuring that the operation is called only once with the specified details.

Returns:

A token ensuring that the operation is called only once with the specified details.

toBuilder

public CreateContactRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateContactRequest.Builder,CreateContactRequest>

Specified by:

toBuilder in class SsmContactsRequest

builder

public static CreateContactRequest.Builder builder()

serializableBuilderClass

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