software.amazon.awssdk.services.servicediscovery.model

Class Operation

java.lang.Object

software.amazon.awssdk.services.servicediscovery.model.Operation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Operation.Builder,Operation>

@Generated(value="software.amazon.awssdk:codegen")
public final class Operation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Operation.Builder,Operation>

A complex type that contains information about a specified operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Operation.Builder

Method Summary

Modifier and Type	Method and Description
static Operation.Builder	builder()
Instant	createDate() The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorCode() The code associated with ErrorMessage.
String	errorMessage() If the value of Status is FAIL, the reason that the operation failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargets() Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	id() The ID of the operation that you want to get information about.
List<SdkField<?>>	sdkFields()
static Class<? extends Operation.Builder>	serializableBuilderClass()
OperationStatus	status() The status of the operation.
String	statusAsString() The status of the operation.
Map<OperationTargetType,String>	targets() The name of the target entity that is associated with the operation:
Map<String,String>	targetsAsStrings() The name of the target entity that is associated with the operation:
Operation.Builder	toBuilder()
String	toString() Returns a string representation of this object.
OperationType	type() The name of the operation that is associated with the specified ID.
String	typeAsString() The name of the operation that is associated with the specified ID.
Instant	updateDate() The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC).

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

id

public final String id()

The ID of the operation that you want to get information about.

Returns:

The ID of the operation that you want to get information about.

type

public final OperationType type()

The name of the operation that is associated with the specified ID.

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

Returns:

The name of the operation that is associated with the specified ID.

See Also:

OperationType

typeAsString

public final String typeAsString()

The name of the operation that is associated with the specified ID.

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

Returns:

The name of the operation that is associated with the specified ID.

See Also:

OperationType

status

public final OperationStatus status()

The status of the operation. Values include the following:

SUBMITTED

This is the initial state immediately after you submit a request.

PENDING

AWS Cloud Map is performing the operation.

SUCCESS

The operation succeeded.

FAIL

The operation failed. For the failure reason, see ErrorMessage.

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

Returns:

The status of the operation. Values include the following:

SUBMITTED

This is the initial state immediately after you submit a request.

PENDING

AWS Cloud Map is performing the operation.

SUCCESS

The operation succeeded.

FAIL

The operation failed. For the failure reason, see ErrorMessage.

See Also:

OperationStatus

statusAsString

public final String statusAsString()

The status of the operation. Values include the following:

SUBMITTED

This is the initial state immediately after you submit a request.

PENDING

AWS Cloud Map is performing the operation.

SUCCESS

The operation succeeded.

FAIL

The operation failed. For the failure reason, see ErrorMessage.

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

Returns:

The status of the operation. Values include the following:

SUBMITTED

This is the initial state immediately after you submit a request.

PENDING

AWS Cloud Map is performing the operation.

SUCCESS

The operation succeeded.

FAIL

The operation failed. For the failure reason, see ErrorMessage.

See Also:

OperationStatus

errorMessage

public final String errorMessage()

If the value of Status is FAIL, the reason that the operation failed.

Returns:

If the value of Status is FAIL, the reason that the operation failed.

errorCode

public final String errorCode()

The code associated with ErrorMessage. Values for ErrorCode include the following:

• ACCESS_DENIED

• CANNOT_CREATE_HOSTED_ZONE

• EXPIRED_TOKEN

• HOSTED_ZONE_NOT_FOUND

• INTERNAL_FAILURE

• INVALID_CHANGE_BATCH

• THROTTLED_REQUEST

Returns:

The code associated with ErrorMessage. Values for ErrorCode include the following:

• ACCESS_DENIED

• CANNOT_CREATE_HOSTED_ZONE

• EXPIRED_TOKEN

• HOSTED_ZONE_NOT_FOUND

• INTERNAL_FAILURE

• INVALID_CHANGE_BATCH

• THROTTLED_REQUEST

createDate

public final Instant createDate()

The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

updateDate

public final Instant updateDate()

The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

targets

public final Map<OperationTargetType,String> targets()

The name of the target entity that is associated with the operation:

NAMESPACE

The namespace ID is returned in the ResourceId property.

SERVICE

The service ID is returned in the ResourceId property.

INSTANCE

The instance ID is returned in the ResourceId property.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTargets() to see if a value was sent in this field.

Returns:

The name of the target entity that is associated with the operation:

NAMESPACE

The namespace ID is returned in the ResourceId property.

SERVICE

The service ID is returned in the ResourceId property.

INSTANCE

The instance ID is returned in the ResourceId property.

hasTargets

public final boolean hasTargets()

Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targetsAsStrings

public final Map<String,String> targetsAsStrings()

The name of the target entity that is associated with the operation:

NAMESPACE

The namespace ID is returned in the ResourceId property.

SERVICE

The service ID is returned in the ResourceId property.

INSTANCE

The instance ID is returned in the ResourceId property.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTargets() to see if a value was sent in this field.

Returns:

The name of the target entity that is associated with the operation:

NAMESPACE

The namespace ID is returned in the ResourceId property.

SERVICE

The service ID is returned in the ResourceId property.

INSTANCE

The instance ID is returned in the ResourceId property.

toBuilder

public Operation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Operation.Builder,Operation>

builder

public static Operation.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo