Class Operation
- java.lang.Object
-
- software.amazon.awssdk.services.servicediscovery.model.Operation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Operation.Builder,Operation>
@Generated("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 Description static interfaceOperation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Operation.Builderbuilder()InstantcreateDate()The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringerrorCode()The code associated withErrorMessage.StringerrorMessage()If the value ofStatusisFAIL, the reason that the operation failed.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTargets()For responses, this returns true if the service returned a value for the Targets property.Stringid()The ID of the operation that you want to get information about.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Operation.Builder>serializableBuilderClass()OperationStatusstatus()The status of the operation.StringstatusAsString()The status of the operation.Map<OperationTargetType,String>targets()The name of the target entity that's associated with the operation:Map<String,String>targetsAsStrings()The name of the target entity that's associated with the operation:Operation.BuildertoBuilder()StringtoString()Returns a string representation of this object.OperationTypetype()The name of the operation that's associated with the specified ID.StringtypeAsString()The name of the operation that's associated with the specified ID.InstantupdateDate()The date and time that the value ofStatuschanged 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's associated with the specified ID.
If the service returns an enum value that is not available in the current SDK version,
typewill returnOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The name of the operation that's associated with the specified ID.
- See Also:
OperationType
-
typeAsString
public final String typeAsString()
The name of the operation that's associated with the specified ID.
If the service returns an enum value that is not available in the current SDK version,
typewill returnOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The name of the operation that's 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 that occurs immediately after you submit a request.
- PENDING
-
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,
statuswill returnOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the operation. Values include the following:
- SUBMITTED
-
This is the initial state that occurs immediately after you submit a request.
- PENDING
-
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 that occurs immediately after you submit a request.
- PENDING
-
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,
statuswill returnOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the operation. Values include the following:
- SUBMITTED
-
This is the initial state that occurs immediately after you submit a request.
- PENDING
-
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
StatusisFAIL, the reason that the operation failed.- Returns:
- If the value of
StatusisFAIL, the reason that the operation failed.
-
errorCode
public final String errorCode()
The code associated with
ErrorMessage. Values forErrorCodeinclude 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 forErrorCodeinclude 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
CreateDateis accurate to milliseconds. For example, the value1516925490.087represents 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
CreateDateis accurate to milliseconds. For example, the value1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
-
updateDate
public final Instant updateDate()
The date and time that the value of
Statuschanged to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value ofUpdateDateis accurate to milliseconds. For example, the value1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- The date and time that the value of
Statuschanged to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value ofUpdateDateis accurate to milliseconds. For example, the value1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.
-
targets
public final Map<OperationTargetType,String> targets()
The name of the target entity that's associated with the operation:
- NAMESPACE
-
The namespace ID is returned in the
ResourceIdproperty. - SERVICE
-
The service ID is returned in the
ResourceIdproperty. - INSTANCE
-
The instance ID is returned in the
ResourceIdproperty.
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
hasTargets()method.- Returns:
- The name of the target entity that's associated with the operation:
- NAMESPACE
-
The namespace ID is returned in the
ResourceIdproperty. - SERVICE
-
The service ID is returned in the
ResourceIdproperty. - INSTANCE
-
The instance ID is returned in the
ResourceIdproperty.
-
hasTargets
public final boolean hasTargets()
For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
targetsAsStrings
public final Map<String,String> targetsAsStrings()
The name of the target entity that's associated with the operation:
- NAMESPACE
-
The namespace ID is returned in the
ResourceIdproperty. - SERVICE
-
The service ID is returned in the
ResourceIdproperty. - INSTANCE
-
The instance ID is returned in the
ResourceIdproperty.
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
hasTargets()method.- Returns:
- The name of the target entity that's associated with the operation:
- NAMESPACE
-
The namespace ID is returned in the
ResourceIdproperty. - SERVICE
-
The service ID is returned in the
ResourceIdproperty. - INSTANCE
-
The instance ID is returned in the
ResourceIdproperty.
-
toBuilder
public Operation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Operation.Builder,Operation>
-
builder
public static Operation.Builder builder()
-
serializableBuilderClass
public static Class<? extends Operation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-