software.amazon.awssdk.services.workdocs.model

Class CreateNotificationSubscriptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workdocs.model.WorkDocsRequest

software.amazon.awssdk.services.workdocs.model.CreateNotificationSubscriptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateNotificationSubscriptionRequest.Builder,CreateNotificationSubscriptionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateNotificationSubscriptionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateNotificationSubscriptionRequest.Builder	builder()
String	endpoint() The endpoint to receive the notifications.
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()
String	organizationId() The ID of the organization.
SubscriptionProtocolType	protocol() The protocol to use.
String	protocolAsString() The protocol to use.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateNotificationSubscriptionRequest.Builder>	serializableBuilderClass()
SubscriptionType	subscriptionType() The notification type.
String	subscriptionTypeAsString() The notification type.
CreateNotificationSubscriptionRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

organizationId

public String organizationId()

The ID of the organization.

Returns:

The ID of the organization.

endpoint

public String endpoint()

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with "https://".

Returns:

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with "https://".

protocol

public SubscriptionProtocolType protocol()

The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

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

Returns:

The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

See Also:

SubscriptionProtocolType

protocolAsString

public String protocolAsString()

The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

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

Returns:

The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

See Also:

SubscriptionProtocolType

subscriptionType

public SubscriptionType subscriptionType()

The notification type.

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

Returns:

The notification type.

See Also:

SubscriptionType

subscriptionTypeAsString

public String subscriptionTypeAsString()

The notification type.

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

Returns:

The notification type.

See Also:

SubscriptionType

toBuilder

public CreateNotificationSubscriptionRequest.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<CreateNotificationSubscriptionRequest.Builder,CreateNotificationSubscriptionRequest>

Specified by:

toBuilder in class WorkDocsRequest

Returns:

a builder for type T

builder

public static CreateNotificationSubscriptionRequest.Builder builder()

serializableBuilderClass

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