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

Class GetCapabilityResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.b2bi.model.B2BiResponse

software.amazon.awssdk.services.b2bi.model.GetCapabilityResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCapabilityResponse.Builder,GetCapabilityResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetCapabilityResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetCapabilityResponse.Builder	builder()
String	capabilityArn()	Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String	capabilityId()	Returns a system-assigned unique identifier for the capability.
CapabilityConfiguration	configuration()	Returns a structure that contains the details for a capability.
Instant	createdAt()	Returns a timestamp for creation date and time of the 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.
List<S3Location>	instructionsDocuments()	Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.
Instant	modifiedAt()	Returns a timestamp for last time the capability was modified.
String	name()	Returns the name of the capability, used to identify it.
List<SdkField<?>>	sdkFields()
static Class<? extends GetCapabilityResponse.Builder>	serializableBuilderClass()
GetCapabilityResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
CapabilityType	type()	Returns the type of the capability.
String	typeAsString()	Returns the type of the capability.

Methods inherited from class software.amazon.awssdk.services.b2bi.model.B2BiResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

capabilityId

public final String capabilityId()

Returns a system-assigned unique identifier for the capability.

Returns:

Returns a system-assigned unique identifier for the capability.

capabilityArn

public final String capabilityArn()

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

Returns:

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

name

public final String name()

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

Returns:

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

type

public final CapabilityType type()

Returns 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:

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

See Also:

CapabilityType

typeAsString

public final String typeAsString()

Returns 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:

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

See Also:

CapabilityType

configuration

public final CapabilityConfiguration configuration()

Returns a structure that contains the details for a capability.

Returns:

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

Returns 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:

Returns 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.

createdAt

public final Instant createdAt()

Returns a timestamp for creation date and time of the capability.

Returns:

Returns a timestamp for creation date and time of the capability.

modifiedAt

public final Instant modifiedAt()

Returns a timestamp for last time the capability was modified.

Returns:

Returns a timestamp for last time the capability was modified.

toBuilder

public GetCapabilityResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCapabilityResponse.Builder,GetCapabilityResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetCapabilityResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetCapabilityResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo