Package software.amazon.awssdk.services.b2bi.model

Class CreateCapabilityRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.b2bi.model.B2BiRequest

software.amazon.awssdk.services.b2bi.model.CreateCapabilityRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCapabilityRequest.Builder,CreateCapabilityRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateCapabilityRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateCapabilityRequest.Builder	builder()
String	clientToken()	Reserved for future use.
CapabilityConfiguration	configuration()	Specifies a structure that contains the details for a capability.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstructionsDocuments()	For responses, this returns true if the service returned a value for the InstructionsDocuments property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<S3Location>	instructionsDocuments()	Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.
String	name()	Specifies the name of the capability, used to identify it.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCapabilityRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.
CreateCapabilityRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
CapabilityType	type()	Specifies the type of the capability.
String	typeAsString()	Specifies the type of the capability.

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

name

public final String name()

Specifies the name of the capability, used to identify it.

Returns:

Specifies the name of the capability, used to identify it.

type

public final CapabilityType type()

Specifies the type of the capability. Currently, only edi is supported.

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

Returns:

Specifies the type of the capability. Currently, only edi is supported.

See Also:

CapabilityType

typeAsString

public final String typeAsString()

Specifies the type of the capability. Currently, only edi is supported.

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

Returns:

Specifies the type of the capability. Currently, only edi is supported.

See Also:

CapabilityType

configuration

public final CapabilityConfiguration configuration()

Specifies a structure that contains the details for a capability.

Returns:

Specifies a structure that contains the details for a capability.

hasInstructionsDocuments

public final boolean hasInstructionsDocuments()

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

instructionsDocuments

public final List<S3Location> instructionsDocuments()

Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

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

Returns:

Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

clientToken

public final String clientToken()

Reserved for future use.

Returns:

Reserved for future use.

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()

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

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:

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

toBuilder

public CreateCapabilityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCapabilityRequest.Builder,CreateCapabilityRequest>

Specified by:

toBuilder in class B2BiRequest

builder

public static CreateCapabilityRequest.Builder builder()

serializableBuilderClass

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