@Generated(value="software.amazon.awssdk:codegen") public final class Operation extends Object implements StructuredPojo, ToCopyableBuilder<Operation.Builder,Operation>
A complex type that contains information about a specified operation.
Modifier and Type | Class and Description |
---|---|
static interface |
Operation.Builder |
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) |
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() |
String |
id()
The ID of the operation that you want to get information about.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
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). |
copy
public String id()
The ID of the operation that you want to get information about.
public 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()
.
OperationType
public 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()
.
OperationType
public OperationStatus status()
The status of the operation. Values include the following:
SUBMITTED: This is the initial state immediately after you submit a request.
PENDING: Amazon Route 53 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()
.
SUBMITTED: This is the initial state immediately after you submit a request.
PENDING: Amazon Route 53 is performing the operation.
SUCCESS: The operation succeeded.
FAIL: The operation failed. For the failure reason, see ErrorMessage
.
OperationStatus
public String statusAsString()
The status of the operation. Values include the following:
SUBMITTED: This is the initial state immediately after you submit a request.
PENDING: Amazon Route 53 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()
.
SUBMITTED: This is the initial state immediately after you submit a request.
PENDING: Amazon Route 53 is performing the operation.
SUCCESS: The operation succeeded.
FAIL: The operation failed. For the failure reason, see ErrorMessage
.
OperationStatus
public String errorMessage()
If the value of Status
is FAIL
, the reason that the operation failed.
Status
is FAIL
, the reason that the operation failed.public String errorCode()
The code associated with ErrorMessage
.
ErrorMessage
.public Instant createDate()
The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).
public 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).
Status
changed to the current value, in Unix date/time
format and Coordinated Universal Time (UTC).public 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.
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.
public 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.
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.
public Operation.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Operation.Builder,Operation>
public static Operation.Builder builder()
public static Class<? extends Operation.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.