Package software.amazon.awssdk.services.kafka.model

Class ClusterOperationInfo

java.lang.Object

software.amazon.awssdk.services.kafka.model.ClusterOperationInfo

All Implemented Interfaces:

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

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

Returns information about a cluster operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClusterOperationInfo.Builder

Method Summary

Modifier and Type	Method	Description
static ClusterOperationInfo.Builder	builder()
String	clientRequestId()	The ID of the API request that triggered this operation.
String	clusterArn()	ARN of the cluster.
Instant	creationTime()	The time that the operation was created.
Instant	endTime()	The time at which the operation finished.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorInfo	errorInfo()	Describes the error if the operation fails.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOperationSteps()	For responses, this returns true if the service returned a value for the OperationSteps property.
String	operationArn()	ARN of the cluster operation.
String	operationState()	State of the cluster operation.
List<ClusterOperationStep>	operationSteps()	Steps completed during the operation.
String	operationType()	Type of the cluster operation.
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterOperationInfo.Builder>	serializableBuilderClass()
MutableClusterInfo	sourceClusterInfo()	Information about cluster attributes before a cluster is updated.
MutableClusterInfo	targetClusterInfo()	Information about cluster attributes after a cluster is updated.
ClusterOperationInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VpcConnectionInfo	vpcConnectionInfo()	Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

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

clientRequestId

public final String clientRequestId()

The ID of the API request that triggered this operation.

Returns:

The ID of the API request that triggered this operation.

clusterArn

public final String clusterArn()

ARN of the cluster.

Returns:

ARN of the cluster.

creationTime

public final Instant creationTime()

The time that the operation was created.

Returns:

The time that the operation was created.

endTime

public final Instant endTime()

The time at which the operation finished.

Returns:

The time at which the operation finished.

errorInfo

public final ErrorInfo errorInfo()

Describes the error if the operation fails.

Returns:

Describes the error if the operation fails.

operationArn

public final String operationArn()

ARN of the cluster operation.

Returns:

ARN of the cluster operation.

operationState

public final String operationState()

State of the cluster operation.

Returns:

State of the cluster operation.

hasOperationSteps

public final boolean hasOperationSteps()

For responses, this returns true if the service returned a value for the OperationSteps 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.

operationSteps

public final List<ClusterOperationStep> operationSteps()

Steps completed during the operation.

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 hasOperationSteps() method.

Returns:

Steps completed during the operation.

operationType

public final String operationType()

Type of the cluster operation.

Returns:

Type of the cluster operation.

sourceClusterInfo

public final MutableClusterInfo sourceClusterInfo()

Information about cluster attributes before a cluster is updated.

Returns:

Information about cluster attributes before a cluster is updated.

targetClusterInfo

public final MutableClusterInfo targetClusterInfo()

Information about cluster attributes after a cluster is updated.

Returns:

Information about cluster attributes after a cluster is updated.

vpcConnectionInfo

public final VpcConnectionInfo vpcConnectionInfo()

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

Returns:

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

toBuilder

public ClusterOperationInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClusterOperationInfo.Builder,ClusterOperationInfo>

builder

public static ClusterOperationInfo.Builder builder()

serializableBuilderClass

public static Class<? extends ClusterOperationInfo.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