Operation (AWS SDK for Java - 2.0.0-preview-10)

java.lang.Object
- software.amazon.awssdk.services.servicediscovery.model.Operation

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<Operation.Builder,Operation>

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

A complex type that contains information about a specified operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Operation.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Operation.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public 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 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 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 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().
    Returns:
    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.
    See Also:
    
    OperationStatus
  - statusAsString
```
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().
    Returns:
    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.
    See Also:
    
    OperationStatus
  - errorMessage
```
public 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 String errorCode()
```
    The code associated with ErrorMessage.
    
    Returns:
    
    The code associated with ErrorMessage.
  - createDate
```
public Instant createDate()
```
    The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).
    
    Returns:
    
    The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).
  - updateDate
```
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).
    
    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).
  - targets
```
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.
    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.
  - targetsAsStrings
```
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.
    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()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Operation.Builder,Operation>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Operation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Operation.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class Operation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

type

typeAsString

status

statusAsString

errorMessage

errorCode

createDate

updateDate

targets

targetsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall